Rollup merge of #59498 - mbrubeck:write_all, r=Centril

Use 'write_all' instead of 'write' in example code

Using `write` without looping and checking the result can cause silent data loss.  Example code should use `write_all` so that people don't copy this pattern.  (Of course this does not include example code for docs that are specifically about the `write` method.)
This commit is contained in:
Mazdak Farrokhzad 2019-03-29 02:40:57 +01:00 committed by GitHub
commit 0494cffd3c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions

View file

@ -1151,7 +1151,7 @@ pub trait Write {
/// fn main() -> std::io::Result<()> {
/// let mut buffer = BufWriter::new(File::create("foo.txt")?);
///
/// buffer.write(b"some bytes")?;
/// buffer.write_all(b"some bytes")?;
/// buffer.flush()?;
/// Ok(())
/// }

View file

@ -405,7 +405,7 @@ pub struct StdoutLock<'a> {
/// use std::io::{self, Write};
///
/// fn main() -> io::Result<()> {
/// io::stdout().write(b"hello world")?;
/// io::stdout().write_all(b"hello world")?;
///
/// Ok(())
/// }
@ -420,7 +420,7 @@ pub struct StdoutLock<'a> {
/// let stdout = io::stdout();
/// let mut handle = stdout.lock();
///
/// handle.write(b"hello world")?;
/// handle.write_all(b"hello world")?;
///
/// Ok(())
/// }
@ -460,7 +460,7 @@ impl Stdout {
/// let stdout = io::stdout();
/// let mut handle = stdout.lock();
///
/// handle.write(b"hello world")?;
/// handle.write_all(b"hello world")?;
///
/// Ok(())
/// }
@ -558,7 +558,7 @@ pub struct StderrLock<'a> {
/// use std::io::{self, Write};
///
/// fn main() -> io::Result<()> {
/// io::stderr().write(b"hello world")?;
/// io::stderr().write_all(b"hello world")?;
///
/// Ok(())
/// }
@ -573,7 +573,7 @@ pub struct StderrLock<'a> {
/// let stderr = io::stderr();
/// let mut handle = stderr.lock();
///
/// handle.write(b"hello world")?;
/// handle.write_all(b"hello world")?;
///
/// Ok(())
/// }
@ -613,7 +613,7 @@ impl Stderr {
/// let stderr = io::stderr();
/// let mut handle = stderr.lock();
///
/// handle.write(b"hello world")?;
/// handle.write_all(b"hello world")?;
///
/// Ok(())
/// }