@@ -2250,18 +2250,18 @@ fn skip_until<R: BufRead + ?Sized>(r: &mut R, delim: u8) -> Result<usize> {
2250
2250
/// ```
2251
2251
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
2252
2252
pub trait BufRead : Read {
2253
- /// Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.
2253
+ /// Returns the contents of the internal buffer, filling it with more data, via ` Read` methods, if empty.
2254
2254
///
2255
2255
/// This is a lower-level method and is meant to be used together with [`consume`],
2256
2256
/// which can be used to mark bytes that should not be returned by subsequent calls to `read`.
2257
2257
///
2258
2258
/// [`consume`]: BufRead::consume
2259
2259
///
2260
- /// Returns an empty buffer to indicate that the stream has reached EOF.
2260
+ /// Returns an empty buffer when the stream has reached EOF.
2261
2261
///
2262
2262
/// # Errors
2263
2263
///
2264
- /// Passes on I/O errors from Read.
2264
+ /// This function will return an I/O error if a ` Read` method was called, but returned an error .
2265
2265
///
2266
2266
/// # Examples
2267
2267
///
@@ -2288,12 +2288,12 @@ pub trait BufRead: Read {
2288
2288
fn fill_buf ( & mut self ) -> Result < & [ u8 ] > ;
2289
2289
2290
2290
/// Marks the given `amount` of additional bytes from the internal buffer as having been read.
2291
- /// Subsequent calls to `read` return bytes that have not yet been so marked.
2291
+ /// Subsequent calls to `read` only return bytes that have not been marked as read .
2292
2292
///
2293
2293
/// This is a lower-level method and is meant to be used together with [`fill_buf`],
2294
- /// which can be used to fill the internal buffer via Read methods.
2294
+ /// which can be used to fill the internal buffer via ` Read` methods.
2295
2295
///
2296
- /// It is a logic error if `amount` exceeds the number of unread bytes in the internal buffer.
2296
+ /// It is a logic error if `amount` exceeds the number of unread bytes in the internal buffer, which is returned by [`fill_buf`] .
2297
2297
///
2298
2298
/// # Examples
2299
2299
///
@@ -2315,7 +2315,7 @@ pub trait BufRead: Read {
2315
2315
///
2316
2316
/// # Errors
2317
2317
///
2318
- /// Passes on I/O errors from Read.
2318
+ /// This function will return an I/O error if a ` Read` method was called, but returned an error .
2319
2319
///
2320
2320
/// Examples
2321
2321
///
0 commit comments