Apply suggestions from code review
Co-authored-by: Ibraheem Ahmed <ibraheem@ibraheem.ca>
This commit is contained in:
parent
51c5700f15
commit
e5b86e2c73
1 changed files with 7 additions and 7 deletions
|
@ -2250,18 +2250,18 @@ fn skip_until<R: BufRead + ?Sized>(r: &mut R, delim: u8) -> Result<usize> {
|
||||||
/// ```
|
/// ```
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
pub trait BufRead: Read {
|
pub trait BufRead: Read {
|
||||||
/// Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.
|
/// Returns the contents of the internal buffer, filling it with more data, via `Read` methods, if empty.
|
||||||
///
|
///
|
||||||
/// This is a lower-level method and is meant to be used together with [`consume`],
|
/// This is a lower-level method and is meant to be used together with [`consume`],
|
||||||
/// which can be used to mark bytes that should not be returned by subsequent calls to `read`.
|
/// which can be used to mark bytes that should not be returned by subsequent calls to `read`.
|
||||||
///
|
///
|
||||||
/// [`consume`]: BufRead::consume
|
/// [`consume`]: BufRead::consume
|
||||||
///
|
///
|
||||||
/// Returns an empty buffer to indicate that the stream has reached EOF.
|
/// Returns an empty buffer when the stream has reached EOF.
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Passes on I/O errors from Read.
|
/// This function will return an I/O error if a `Read` method was called, but returned an error.
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
@ -2288,12 +2288,12 @@ pub trait BufRead: Read {
|
||||||
fn fill_buf(&mut self) -> Result<&[u8]>;
|
fn fill_buf(&mut self) -> Result<&[u8]>;
|
||||||
|
|
||||||
/// Marks the given `amount` of additional bytes from the internal buffer as having been read.
|
/// Marks the given `amount` of additional bytes from the internal buffer as having been read.
|
||||||
/// Subsequent calls to `read` return bytes that have not yet been so marked.
|
/// Subsequent calls to `read` only return bytes that have not been marked as read.
|
||||||
///
|
///
|
||||||
/// This is a lower-level method and is meant to be used together with [`fill_buf`],
|
/// This is a lower-level method and is meant to be used together with [`fill_buf`],
|
||||||
/// which can be used to fill the internal buffer via Read methods.
|
/// which can be used to fill the internal buffer via `Read` methods.
|
||||||
///
|
///
|
||||||
/// It is a logic error if `amount` exceeds the number of unread bytes in the internal buffer.
|
/// It is a logic error if `amount` exceeds the number of unread bytes in the internal buffer, which is returned by [`fill_buf`].
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
@ -2315,7 +2315,7 @@ pub trait BufRead: Read {
|
||||||
///
|
///
|
||||||
/// # Errors
|
/// # Errors
|
||||||
///
|
///
|
||||||
/// Passes on I/O errors from Read.
|
/// This function will return an I/O error if a `Read` method was called, but returned an error.
|
||||||
///
|
///
|
||||||
/// Examples
|
/// Examples
|
||||||
///
|
///
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue