diff options
| author | Elinvynia <59487684+Elinvynia@users.noreply.github.com> | 2020-05-09 01:17:20 +0200 |
|---|---|---|
| committer | Elinvynia <59487684+Elinvynia@users.noreply.github.com> | 2020-05-09 01:17:20 +0200 |
| commit | 05fc7faacb7c33eaad6614f62a7d560b0d2660a5 (patch) | |
| tree | f56803ffa1e6495ebab9b986c1a0f706719f2790 | |
| parent | 7b805396bf46dce972692a6846ce2ad8481c5f85 (diff) | |
| download | rust-05fc7faacb7c33eaad6614f62a7d560b0d2660a5.tar.gz rust-05fc7faacb7c33eaad6614f62a7d560b0d2660a5.zip | |
Better documentation for io::Read::read() return value
| -rw-r--r-- | src/libstd/io/mod.rs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index 36c6aa620d5..ebe6d09023f 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -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* |