From d88cce24238cc76b45e647448d99a87e98cd86b7 Mon Sep 17 00:00:00 2001 From: Alexis Bourget Date: Sat, 18 Jul 2020 23:20:58 +0200 Subject: [PATCH 1/2] Add a link to read in the read_exact doc about the guarantees --- src/libstd/io/mod.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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 From e88220f86749d88e53c5dbaa421dcaba1889f86c Mon Sep 17 00:00:00 2001 From: Alexis Bourget Date: Sun, 19 Jul 2020 15:30:32 +0200 Subject: [PATCH 2/2] Fix small nit in the link to read --- src/libstd/io/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index aba67df0063..73a6f08df65 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -766,7 +766,7 @@ pub trait Read { /// /// [`File`]s implement `Read`: /// - /// [`read`]: trait.Read.html#tymethod.read + /// [`read`]: Read::read /// [`File`]: ../fs/struct.File.html /// [`ErrorKind::Interrupted`]: ../../std/io/enum.ErrorKind.html#variant.Interrupted /// [`ErrorKind::UnexpectedEof`]: ../../std/io/enum.ErrorKind.html#variant.UnexpectedEof