about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorThomas de Zeeuw <thomasdezeeuw@gmail.com>2020-04-01 15:39:05 +0200
committerThomas de Zeeuw <thomasdezeeuw@gmail.com>2020-04-01 15:39:05 +0200
commit9745b1fc52efb22f6be501db9282d8202e290066 (patch)
tree7d3602a7bf6f2b012b1d52654ef9ac039d51bf06 /src/libstd
parent33a49993b440ab56cd425d8d4137d5fe17dcaae5 (diff)
downloadrust-9745b1fc52efb22f6be501db9282d8202e290066.tar.gz
rust-9745b1fc52efb22f6be501db9282d8202e290066.zip
Use unspecified over undefined in io::Write::write_all_vectored docs
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/mod.rs16
1 files changed, 9 insertions, 7 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index a9ebbbf7e89..68ce7e13e26 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -1388,19 +1388,21 @@ pub trait Write {
     ///
     /// If the buffer contains no data, this will never call [`write_vectored`].
     ///
+    /// [`write_vectored`]: #tymethod.write_vectored
+    /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
+    ///
     /// # Notes
     ///
     /// Different to `io::Write::write_vectored` this takes a *mutable*
     /// reference to a slice of `IoSlice`s, not a non-mutable reference, because
     /// we need to modify the slice to keep track of the bytes already written.
     ///
-    /// Once this function returns the contents of `bufs` is undefined, not
-    /// undefined as in memory unsafe but we don't know what the contents of
-    /// `bufs` will be as that depends on how many writes we needed to do. We
-    /// advice to see this function as taking ownership of `bufs` and don't use
-    /// the variable after the future returns. The underlying buffers, to which
-    /// `IoSlice` points (not the `IoSlice` itself), are unchanged and can be
-    /// reused.
+    /// Once this function returns the contents of `bufs` is unspecified, as we
+    /// don't know what the contents of `bufs` will be as that depends on how
+    /// many writes we needed to do. We advice to see this function as taking
+    /// ownership of `bufs` and don't use the variable after the future returns.
+    /// The underlying buffers, to which `IoSlice` points (not the `IoSlice`
+    /// itself), are unchanged and can be reused.
     ///
     /// # Examples
     ///