Skip to content

Improve Read::read_exact documentation #74486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 20, 2020
Merged

Improve Read::read_exact documentation #74486

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d88cce2
Add a link to read in the read_exact doc about the guarantees
poliorcetics Jul 18, 2020
e88220f
Fix small nit in the link to read
poliorcetics Jul 19, 2020
471dd52
Fix merge conflict with recent PR
poliorcetics Jul 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/libstd/io/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand All @@ -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
Expand Down