From edb21189e233064a378dec0a0cd1ce8772b918aa Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 20 May 2015 22:02:46 +0200 Subject: [PATCH] doc: 'reader' and 'writer' are nicer to read than 'r' and 'w' --- src/libstd/io/util.rs | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs index d797e757a483e..5fbf650dc3f00 100644 --- a/src/libstd/io/util.rs +++ b/src/libstd/io/util.rs @@ -16,11 +16,12 @@ use io::{self, Read, Write, ErrorKind, BufRead}; /// Copies the entire contents of a reader into a writer. /// -/// This function will continuously read data from `r` and then write it into -/// `w` in a streaming fashion until `r` returns EOF. +/// This function will continuously read data from `reader` and then +/// write it into `writer` in a streaming fashion until `reader` +/// returns EOF. /// -/// On success the total number of bytes that were copied from `r` to `w` is -/// returned. +/// On success, the total number of bytes that were copied from +/// `reader` to `writer` is returned. /// /// # Errors /// @@ -28,17 +29,17 @@ use io::{self, Read, Write, ErrorKind, BufRead}; /// `write` returns an error. All instances of `ErrorKind::Interrupted` are /// handled by this function and the underlying operation is retried. #[stable(feature = "rust1", since = "1.0.0")] -pub fn copy(r: &mut R, w: &mut W) -> io::Result { +pub fn copy(reader: &mut R, writer: &mut W) -> io::Result { let mut buf = [0; super::DEFAULT_BUF_SIZE]; let mut written = 0; loop { - let len = match r.read(&mut buf) { + let len = match reader.read(&mut buf) { Ok(0) => return Ok(written), Ok(len) => len, Err(ref e) if e.kind() == ErrorKind::Interrupted => continue, Err(e) => return Err(e), }; - try!(w.write_all(&buf[..len])); + try!(writer.write_all(&buf[..len])); written += len as u64; } }