rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Better documentation for io::Read::read() return value

Browse Source
This commit is contained in:
Elinvynia
2020-05-09 01:17:20 +02:00
parent 7b805396bf
commit 05fc7faacb
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/libstd/io/mod.rs
View File

@@ -517,6 +517,11 @@ pub trait Read {
/// reader will *always* no longer be able to produce bytes. /// reader will *always* no longer be able to produce bytes.
/// 2. The buffer specified was 0 bytes in length. /// 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 /// No guarantees are provided about the contents of `buf` when this
/// function is called, implementations cannot rely on any property of the /// function is called, implementations cannot rely on any property of the
/// contents of `buf` being true. It is recommended that *implementations* /// contents of `buf` being true. It is recommended that *implementations*