@@ -4,7 +4,7 @@ use crate::io::{ErrorKind, Lines, Read, Result, Split, append_to_string, lines,
44use crate :: string:: String ;
55use crate :: vec:: Vec ;
66
7- /// A `BufRead` is a type of `Read`er which has an internal buffer, allowing it
7+ /// A `BufRead` is a type of [ `Read`] er which has an internal buffer, allowing it
88/// to perform extra ways of reading.
99///
1010/// For example, reading line-by-line is inefficient without using a buffer, so
@@ -55,7 +55,7 @@ use crate::vec::Vec;
5555#[ stable( feature = "rust1" , since = "1.0.0" ) ]
5656#[ cfg_attr( not( test) , rustc_diagnostic_item = "IoBufRead" ) ]
5757pub trait BufRead : Read {
58- /// Returns the contents of the internal buffer, filling it with more data, via `Read` methods, if empty.
58+ /// Returns the contents of the internal buffer, filling it with more data, via [ `Read`] methods, if empty.
5959 ///
6060 /// This is a lower-level method and is meant to be used together with [`consume`],
6161 /// which can be used to mark bytes that should not be returned by subsequent calls to `read`.
@@ -66,7 +66,7 @@ pub trait BufRead: Read {
6666 ///
6767 /// # Errors
6868 ///
69- /// This function will return an I/O error if a `Read` method was called, but returned an error.
69+ /// This function will return an I/O error if a [ `Read`] method was called, but returned an error.
7070 ///
7171 /// # Examples
7272 ///
@@ -96,7 +96,7 @@ pub trait BufRead: Read {
9696 /// Subsequent calls to `read` only return bytes that have not been marked as read.
9797 ///
9898 /// This is a lower-level method and is meant to be used together with [`fill_buf`],
99- /// which can be used to fill the internal buffer via `Read` methods.
99+ /// which can be used to fill the internal buffer via [ `Read`] methods.
100100 ///
101101 /// It is a logic error if `amount` exceeds the number of unread bytes in the internal buffer, which is returned by [`fill_buf`].
102102 ///
@@ -120,7 +120,7 @@ pub trait BufRead: Read {
120120 ///
121121 /// # Errors
122122 ///
123- /// This function will return an I/O error if a `Read` method was called, but returned an error.
123+ /// This function will return an I/O error if a [ `Read`] method was called, but returned an error.
124124 ///
125125 /// Examples
126126 ///
@@ -274,7 +274,7 @@ pub trait BufRead: Read {
274274 }
275275
276276 /// Reads all bytes until a newline (the `0xA` byte) is reached, and append
277- /// them to the provided `String` buffer.
277+ /// them to the provided [ `String`] buffer.
278278 ///
279279 /// Previous content of the buffer will be preserved. To avoid appending to
280280 /// the buffer, you need to [`clear`] it first.
0 commit comments