Skip to content

Commit

Permalink
Better documentation for io::Read::read() return value
Browse files Browse the repository at this point in the history
  • Loading branch information
Elinvynia committed May 8, 2020
1 parent 7b80539 commit 05fc7fa
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/libstd/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,11 @@ pub trait Read {
/// reader will *always* no longer be able to produce bytes.
/// 2. The buffer specified was 0 bytes in length.
///
/// It is not an error if the returned value `n` is smaller than the buffer size,
/// even when the reader is not at the end of the stream yet.
/// This may happen for example because fewer bytes are actually available right now
/// (e. g. being close to end-of-file) or because read() was interrupted by a signal.
///
/// 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*
Expand Down

0 comments on commit 05fc7fa

Please sign in to comment.