about summary refs log tree commit diff
path: root/src/libstd/io/mod.rs
diff options
context:
space:
mode:
authorAlexis Bourget <alexis.bourget@gmail.com>2020-07-18 23:20:58 +0200
committerAlexis Bourget <alexis.bourget@gmail.com>2020-07-18 23:20:58 +0200
commitd88cce24238cc76b45e647448d99a87e98cd86b7 (patch)
tree6703c1391c8ff37bda2c758fec60292c9ea0d72e /src/libstd/io/mod.rs
parent1fa54ad9680cc82e7301f8ed4e9b7402dfd6ce0e (diff)
downloadrust-d88cce24238cc76b45e647448d99a87e98cd86b7.tar.gz
rust-d88cce24238cc76b45e647448d99a87e98cd86b7.zip
Add a link to read in the read_exact doc about the guarantees
Diffstat (limited to 'src/libstd/io/mod.rs')
-rw-r--r--src/libstd/io/mod.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index d5af4f25102..aba67df0063 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -741,7 +741,9 @@ pub trait Read {
     /// No guarantees are provided about the contents of `buf` when this
     /// function is called, implementations cannot rely on any property of the
     /// contents of `buf` being true. It is recommended that implementations
-    /// only write data to `buf` instead of reading its contents.
+    /// only write data to `buf` instead of reading its contents. The
+    /// documentation on [`read`] has a more detailed explanation on this
+    /// subject.
     ///
     /// # Errors
     ///
@@ -764,6 +766,7 @@ pub trait Read {
     ///
     /// [`File`]s implement `Read`:
     ///
+    /// [`read`]: trait.Read.html#tymethod.read
     /// [`File`]: ../fs/struct.File.html
     /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted
     /// [`ErrorKind::UnexpectedEof`]: ../../std/io/enum.ErrorKind.html#variant.UnexpectedEof