Skip to content

Commit

Permalink
Beef up BufRead::consume documentation.
Browse files Browse the repository at this point in the history
Fixes #23196
  • Loading branch information
steveklabnik committed Mar 23, 2015
1 parent ecf8c64 commit a5e1cbe
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/libstd/io/mod.rs
Expand Up @@ -558,6 +558,12 @@ pub trait BufRead: Read {
/// This function does not perform any I/O, it simply informs this object
/// that some amount of its buffer, returned from `fill_buf`, has been
/// consumed and should no longer be returned.
///
/// This function is used to tell the buffer how many bytes you've consumed
/// from the return value of `fill_buf`, and so may do odd things if
/// `fill_buf` isn't called before calling this.
///
/// The `amt` must be `<=` the number of bytes in the buffer returned by `fill_buf`.
#[stable(feature = "rust1", since = "1.0.0")]
fn consume(&mut self, amt: usize);

Expand Down

0 comments on commit a5e1cbe

Please sign in to comment.