bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Beef up BufRead::consume documentation.

Browse source 
Fixes #23196
This commit is contained in:
Steve Klabnik 2015-03-22 18:38:40 -04:00
parent ecf8c64e1b
commit a5e1cbe191
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/libstd/io/mod.rs
View file

@ -558,6 +558,12 @@ pub trait BufRead: Read {
/// This function does not perform any I/O, it simply informs this object /// 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 /// that some amount of its buffer, returned from `fill_buf`, has been
/// consumed and should no longer be returned. /// 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")] #[stable(feature = "rust1", since = "1.0.0")]
fn consume(&mut self, amt: usize); fn consume(&mut self, amt: usize);