diff options
| author | bors <bors@rust-lang.org> | 2015-07-08 19:26:30 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2015-07-08 19:26:30 +0000 |
| commit | 15952ac6cf39c593ae2b9c2cd161f2e221324e6a (patch) | |
| tree | d98060271ef0c504b8228a8d439e4e3b431f2cc9 /src/libstd | |
| parent | 50df2a09b8b9dd4883eb27d833a8482799175a3b (diff) | |
| parent | 546ce79570c618c0f5ffa72e85535675fab43408 (diff) | |
| download | rust-15952ac6cf39c593ae2b9c2cd161f2e221324e6a.tar.gz rust-15952ac6cf39c593ae2b9c2cd161f2e221324e6a.zip | |
Auto merge of #26894 - steveklabnik:rollup, r=steveklabnik
- Successful merges: #26687, #26784, #26850, #26889, #26891, #26892, #26893 - Failed merges:
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/io/buffered.rs | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs index 1d0152e2751..d389a0be117 100644 --- a/src/libstd/io/buffered.rs +++ b/src/libstd/io/buffered.rs @@ -21,7 +21,7 @@ use io::{self, DEFAULT_BUF_SIZE, Error, ErrorKind, SeekFrom}; use ptr; use iter; -/// Wraps a `Read` and buffers input from it +/// Wraps a `Read` and buffers input from it. /// /// It can be excessively inefficient to work directly with a `Read` instance. /// For example, every call to `read` on `TcpStream` results in a system call. @@ -54,13 +54,13 @@ pub struct BufReader<R> { } impl<R: Read> BufReader<R> { - /// Creates a new `BufReader` with a default buffer capacity + /// Creates a new `BufReader` with a default buffer capacity. #[stable(feature = "rust1", since = "1.0.0")] pub fn new(inner: R) -> BufReader<R> { BufReader::with_capacity(DEFAULT_BUF_SIZE, inner) } - /// Creates a new `BufReader` with the specified buffer capacity + /// Creates a new `BufReader` with the specified buffer capacity. #[stable(feature = "rust1", since = "1.0.0")] pub fn with_capacity(cap: usize, inner: R) -> BufReader<R> { let mut buf = Vec::with_capacity(cap); @@ -183,7 +183,7 @@ impl<R: Seek> Seek for BufReader<R> { } } -/// Wraps a Writer and buffers output to it +/// Wraps a Writer and buffers output to it. /// /// It can be excessively inefficient to work directly with a `Write`. For /// example, every call to `write` on `TcpStream` results in a system call. A @@ -205,13 +205,13 @@ pub struct BufWriter<W: Write> { pub struct IntoInnerError<W>(W, Error); impl<W: Write> BufWriter<W> { - /// Creates a new `BufWriter` with a default buffer capacity + /// Creates a new `BufWriter` with a default buffer capacity. #[stable(feature = "rust1", since = "1.0.0")] pub fn new(inner: W) -> BufWriter<W> { BufWriter::with_capacity(DEFAULT_BUF_SIZE, inner) } - /// Creates a new `BufWriter` with the specified buffer capacity + /// Creates a new `BufWriter` with the specified buffer capacity. #[stable(feature = "rust1", since = "1.0.0")] pub fn with_capacity(cap: usize, inner: W) -> BufWriter<W> { BufWriter { @@ -253,11 +253,11 @@ impl<W: Write> BufWriter<W> { #[stable(feature = "rust1", since = "1.0.0")] pub fn get_ref(&self) -> &W { self.inner.as_ref().unwrap() } - /// Gets a mutable reference to the underlying write. + /// Gets a mutable reference to the underlying writer. /// /// # Warning /// - /// It is inadvisable to directly read from the underlying writer. + /// It is inadvisable to directly write to the underlying writer. #[stable(feature = "rust1", since = "1.0.0")] pub fn get_mut(&mut self) -> &mut W { self.inner.as_mut().unwrap() } |
