Skip to content

Commit

Permalink
Rollup merge of rust-lang#56124 - antoine-de:fix_read_to_end_doc_mist…
Browse files Browse the repository at this point in the history
…ake, r=TimNN

Fix small doc mistake on std::io::read::read_to_end

The std::io::read main documentation can lead to error because the buffer is prefilled with 10 zeros that will pad the response.
Using an empty vector is better.

The `read_to_end` documentation is already correct though.

This is my first rust PR, don't hesitate to tell me if I did something wrong.
  • Loading branch information
pietroalbini committed Nov 28, 2018
2 parents 962e210 + 1ed9195 commit 5fc9d68
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/libstd/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ fn read_to_end_with_reservation<R: Read + ?Sized>(r: &mut R,
/// // read up to 10 bytes
/// f.read(&mut buffer)?;
///
/// let mut buffer = vec![0; 10];
/// let mut buffer = Vec::new();
/// // read the whole file
/// f.read_to_end(&mut buffer)?;
///
Expand Down

0 comments on commit 5fc9d68

Please sign in to comment.