Skip to content

Commit 9745b1f

Browse files
committed
Use unspecified over undefined in io::Write::write_all_vectored docs
1 parent 33a4999 commit 9745b1f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

src/libstd/io/mod.rs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1388,19 +1388,21 @@ pub trait Write {
13881388
///
13891389
/// If the buffer contains no data, this will never call [`write_vectored`].
13901390
///
1391+
/// [`write_vectored`]: #tymethod.write_vectored
1392+
/// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
1393+
///
13911394
/// # Notes
13921395
///
13931396
/// Different to `io::Write::write_vectored` this takes a *mutable*
13941397
/// reference to a slice of `IoSlice`s, not a non-mutable reference, because
13951398
/// we need to modify the slice to keep track of the bytes already written.
13961399
///
1397-
/// Once this function returns the contents of `bufs` is undefined, not
1398-
/// undefined as in memory unsafe but we don't know what the contents of
1399-
/// `bufs` will be as that depends on how many writes we needed to do. We
1400-
/// advice to see this function as taking ownership of `bufs` and don't use
1401-
/// the variable after the future returns. The underlying buffers, to which
1402-
/// `IoSlice` points (not the `IoSlice` itself), are unchanged and can be
1403-
/// reused.
1400+
/// Once this function returns the contents of `bufs` is unspecified, as we
1401+
/// don't know what the contents of `bufs` will be as that depends on how
1402+
/// many writes we needed to do. We advice to see this function as taking
1403+
/// ownership of `bufs` and don't use the variable after the future returns.
1404+
/// The underlying buffers, to which `IoSlice` points (not the `IoSlice`
1405+
/// itself), are unchanged and can be reused.
14041406
///
14051407
/// # Examples
14061408
///

0 commit comments

Comments
 (0)