about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTshepang Lekhonkhobe <tshepang@gmail.com>2015-05-20 22:02:46 +0200
committerTshepang Lekhonkhobe <tshepang@gmail.com>2015-05-20 22:02:46 +0200
commitedb21189e233064a378dec0a0cd1ce8772b918aa (patch)
tree5bcbf50e6ba74a2d094f1401ce7974b18e75f2c2
parentd7185dcff12a6963535e73ed4b0f392da236068c (diff)
downloadrust-edb21189e233064a378dec0a0cd1ce8772b918aa.tar.gz
rust-edb21189e233064a378dec0a0cd1ce8772b918aa.zip
doc: 'reader' and 'writer' are nicer to read than 'r' and 'w'
-rw-r--r--src/libstd/io/util.rs15
1 files changed, 8 insertions, 7 deletions
diff --git a/src/libstd/io/util.rs b/src/libstd/io/util.rs
index d797e757a48..5fbf650dc3f 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: Read, W: Write>(r: &mut R, w: &mut W) -> io::Result<u64> {
+pub fn copy<R: Read, W: Write>(reader: &mut R, writer: &mut W) -> io::Result<u64> {
     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;
     }
 }