Skip to content

Commit

Permalink
Update documentation for fill_buf in std::io::BufRead
Browse files Browse the repository at this point in the history
Brings the documentation in line with the BufReader implementation.

Fixes rust-lang#48022.
  • Loading branch information
Alva Snædís committed Sep 7, 2018
1 parent fc81e36 commit aa4f73c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/libstd/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit aa4f73c

Please sign in to comment.