diff options
| author | Alva Snædís <alva@alva.email> | 2018-09-07 23:16:55 +0000 |
|---|---|---|
| committer | Alva Snædís <alva@alva.email> | 2018-09-07 23:16:55 +0000 |
| commit | aa4f73c845f29188acf51a42db7d3d86b827cb6f (patch) | |
| tree | 29b00993887b888fe24ea21bee8be12aea5ad970 /src/libstd | |
| parent | fc81e36242ddddb7149a0d1ca44ebce7fb9eef8a (diff) | |
| download | rust-aa4f73c845f29188acf51a42db7d3d86b827cb6f.tar.gz rust-aa4f73c845f29188acf51a42db7d3d86b827cb6f.zip | |
Update documentation for fill_buf in std::io::BufRead
Brings the documentation in line with the BufReader implementation. Fixes #48022.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/io/mod.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs index b83f3fbe7a5..278ee7951b3 100644 --- a/src/libstd/io/mod.rs +++ b/src/libstd/io/mod.rs @@ -1330,7 +1330,8 @@ fn read_until<R: BufRead + ?Sized>(r: &mut R, delim: u8, buf: &mut Vec<u8>) /// #[stable(feature = "rust1", since = "1.0.0")] pub trait BufRead: Read { - /// Fills the internal buffer of this object, returning the buffer contents. + /// Returns the contents of the internal buffer, filling it with more data + /// from the inner reader if it is empty. /// /// This function is a lower-level call. It needs to be paired with the /// [`consume`] method to function properly. When calling this |