@@ -922,12 +922,14 @@ pub trait Read {
922
922
/// `read_to_end` attempts to read a source until EOF, but many sources are continuous streams
923
923
/// that do not send EOF. In these cases, `read_to_end` will block indefinitely. Standard input
924
924
/// is one such stream which may be finite if piped, but is typically continuous. For example,
925
- /// `cat < file> | <my_rust_program> ` will correctly terminate with an `EOF` upon closure of cat.
925
+ /// `cat file | my-rust-program ` will correctly terminate with an `EOF` upon closure of cat.
926
926
/// Reading user input or running programs that remain open indefinitely will never terminate
927
- /// the stream with `EOF` (e.g. `yes "Data" | pv | <my_rust_program `).
927
+ /// the stream with `EOF` (e.g. `yes | my-rust-program `).
928
928
///
929
929
/// Using `.lines()` with a [`BufReader`] or using [`read`] can provide a better solution
930
930
///
931
+ ///[`read`]: Read::read
932
+ ///
931
933
/// [`Vec::try_reserve`]: crate::vec::Vec::try_reserve
932
934
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
933
935
fn read_to_end ( & mut self , buf : & mut Vec < u8 > ) -> Result < usize > {
@@ -975,13 +977,15 @@ pub trait Read {
975
977
///
976
978
/// `read_to_string` attempts to read a source until EOF, but many sources are continuous streams
977
979
/// that do not send EOF. In these cases, `read_to_string` will block indefinitely. Standard input
978
- /// is one such stream which may be finite if piped, but is typically continuous. FFor example,
979
- /// `cat < file> | <my_rust_program> ` will correctly terminate with an `EOF` upon closure of cat.
980
+ /// is one such stream which may be finite if piped, but is typically continuous. For example,
981
+ /// `cat file | my-rust-program ` will correctly terminate with an `EOF` upon closure of cat.
980
982
/// Reading user input or running programs that remain open indefinitely will never terminate
981
- /// the stream with `EOF` (e.g. `yes "Data" | pv | <my_rust_program `).
983
+ /// the stream with `EOF` (e.g. `yes | my-rust-program `).
982
984
///
983
985
/// Using `.lines()` with a [`BufReader`] or using [`read`] can provide a better solution
984
986
///
987
+ ///[`read`]: Read::read
988
+ ///
985
989
/// [`std::fs::read_to_string`]: crate::fs::read_to_string
986
990
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
987
991
fn read_to_string ( & mut self , buf : & mut String ) -> Result < usize > {
@@ -1290,11 +1294,14 @@ pub trait Read {
1290
1294
/// `read_to_string` attempts to read a source until EOF, but many sources are continuous streams
1291
1295
/// that do not send EOF. In these cases, `read_to_string` will block indefinitely. Standard input
1292
1296
/// is one such stream which may be finite if piped, but is typically continuous. For example,
1293
- /// `cat < file> | <my_rust_program> ` will correctly terminate with an `EOF` upon closure of cat.
1297
+ /// `cat file | my-rust-program ` will correctly terminate with an `EOF` upon closure of cat.
1294
1298
/// Reading user input or running programs that remain open indefinitely will never terminate
1295
- /// the stream with `EOF` (e.g. `yes "Data" | pv | <my_rust_program `).
1299
+ /// the stream with `EOF` (e.g. `yes | my-rust-program `).
1296
1300
///
1297
1301
/// Using `.lines()` with a [`BufReader`] or using [`read`] can provide a better solution
1302
+ ///
1303
+ ///[`read`]: Read::read
1304
+ ///
1298
1305
#[ stable( feature = "io_read_to_string" , since = "1.65.0" ) ]
1299
1306
pub fn read_to_string < R : Read > ( mut reader : R ) -> Result < String > {
1300
1307
let mut buf = String :: new ( ) ;
0 commit comments