diff options
Diffstat (limited to 'tokio/src/io/util')
| -rw-r--r-- | tokio/src/io/util/async_buf_read_ext.rs | 4 | ||||
| -rw-r--r-- | tokio/src/io/util/async_read_ext.rs | 20 | ||||
| -rw-r--r-- | tokio/src/io/util/async_write_ext.rs | 10 | ||||
| -rw-r--r-- | tokio/src/io/util/buf_stream.rs | 2 |
4 files changed, 18 insertions, 18 deletions
diff --git a/tokio/src/io/util/async_buf_read_ext.rs b/tokio/src/io/util/async_buf_read_ext.rs index 90789744..1bfab902 100644 --- a/tokio/src/io/util/async_buf_read_ext.rs +++ b/tokio/src/io/util/async_buf_read_ext.rs @@ -9,7 +9,7 @@ cfg_io_util! { /// /// [`AsyncBufRead`]: crate::io::AsyncBufRead pub trait AsyncBufReadExt: AsyncBufRead { - /// Read all bytes into `buf` until the delimiter `byte` or EOF is reached. + /// Reads all bytes into `buf` until the delimiter `byte` or EOF is reached. /// /// Equivalent to: /// @@ -85,7 +85,7 @@ cfg_io_util! { read_until(self, byte, buf) } - /// Read all bytes until a newline (the 0xA byte) is reached, and append + /// Reads all bytes until a newline (the 0xA byte) is reached, and append /// them to the provided buffer. /// /// Equivalent to: diff --git a/tokio/src/io/util/async_read_ext.rs b/tokio/src/io/util/async_read_ext.rs index 4ffb769c..d4402db6 100644 --- a/tokio/src/io/util/async_read_ext.rs +++ b/tokio/src/io/util/async_read_ext.rs @@ -12,7 +12,7 @@ use crate::io::AsyncRead; use bytes::BufMut; cfg_io_util! { - /// Define numeric reader + /// Defines numeric reader macro_rules! read_impl { ( $( @@ -29,7 +29,7 @@ cfg_io_util! { } } - /// Read bytes from a source. + /// Reads bytes from a source. /// /// Implemented as an extention trait, adding utility methods to all /// [`AsyncRead`] types. Callers will tend to import this trait instead of @@ -58,7 +58,7 @@ cfg_io_util! { /// [`AsyncRead`]: AsyncRead /// [`prelude`]: crate::prelude pub trait AsyncReadExt: AsyncRead { - /// Create a new `AsyncRead` instance that chains this stream with + /// Creates a new `AsyncRead` instance that chains this stream with /// `next`. /// /// The returned `AsyncRead` instance will first read all bytes from this object @@ -95,7 +95,7 @@ cfg_io_util! { chain(self, next) } - /// Pull some bytes from this source into the specified buffer, + /// Pulls some bytes from this source into the specified buffer, /// returning how many bytes were read. /// /// Equivalent to: @@ -120,7 +120,7 @@ cfg_io_util! { /// /// No guarantees are provided about the contents of `buf` when this /// function is called, implementations cannot rely on any property of the - /// contents of `buf` being true. It is recommended that *implementations* + /// contents of `buf` being `true`. It is recommended that *implementations* /// only write data to `buf` instead of reading its contents. /// /// Correspondingly, however, *callers* of this method may not assume @@ -162,7 +162,7 @@ cfg_io_util! { read(self, buf) } - /// Pull some bytes from this source into the specified buffer, + /// Pulls some bytes from this source into the specified buffer, /// advancing the buffer's internal cursor. /// /// Equivalent to: @@ -227,7 +227,7 @@ cfg_io_util! { read_buf(self, buf) } - /// Read the exact number of bytes required to fill `buf`. + /// Reads the exact number of bytes required to fill `buf`. /// /// Equivalent to: /// @@ -240,7 +240,7 @@ cfg_io_util! { /// /// No guarantees are provided about the contents of `buf` when this /// function is called, implementations cannot rely on any property of - /// the contents of `buf` being true. It is recommended that + /// the contents of `buf` being `true`. It is recommended that /// implementations only write data to `buf` instead of reading its /// contents. /// @@ -671,7 +671,7 @@ cfg_io_util! { fn read_i128(&mut self) -> ReadI128; } - /// Read all bytes until EOF in this source, placing them into `buf`. + /// Reads all bytes until EOF in this source, placing them into `buf`. /// /// Equivalent to: /// @@ -721,7 +721,7 @@ cfg_io_util! { read_to_end(self, buf) } - /// Read all bytes until EOF in this source, appending them to `buf`. + /// Reads all bytes until EOF in this source, appending them to `buf`. /// /// Equivalent to: /// diff --git a/tokio/src/io/util/async_write_ext.rs b/tokio/src/io/util/async_write_ext.rs index e54501d9..377f4eca 100644 --- a/tokio/src/io/util/async_write_ext.rs +++ b/tokio/src/io/util/async_write_ext.rs @@ -10,7 +10,7 @@ use crate::io::AsyncWrite; use bytes::Buf; cfg_io_util! { - /// Define numeric writer + /// Defines numeric writer macro_rules! write_impl { ( $( @@ -27,7 +27,7 @@ cfg_io_util! { } } - /// Write bytes to a sink. + /// Writes bytes to a sink. /// /// Implemented as an extention trait, adding utility methods to all /// [`AsyncWrite`] types. Callers will tend to import this trait instead of @@ -60,7 +60,7 @@ cfg_io_util! { /// [`AsyncWrite`]: AsyncWrite /// [`prelude`]: crate::prelude pub trait AsyncWriteExt: AsyncWrite { - /// Write a buffer into this writer, returning how many bytes were + /// Writes a buffer into this writer, returning how many bytes were /// written. /// /// Equivalent to: @@ -113,7 +113,7 @@ cfg_io_util! { write(self, src) } - /// Write a buffer into this writer, advancing the buffer's internal + /// Writes a buffer into this writer, advancing the buffer's internal /// cursor. /// /// Equivalent to: @@ -610,7 +610,7 @@ cfg_io_util! { fn write_i128(&mut self, n: i128) -> WriteI128; } - /// Flush this output stream, ensuring that all intermediately buffered + /// Flushes this output stream, ensuring that all intermediately buffered /// contents reach their destination. /// /// Equivalent to: diff --git a/tokio/src/io/util/buf_stream.rs b/tokio/src/io/util/buf_stream.rs index 12b213d0..a56a4517 100644 --- a/tokio/src/io/util/buf_stream.rs +++ b/tokio/src/io/util/buf_stream.rs @@ -24,7 +24,7 @@ pin_project! { } impl<RW: AsyncRead + AsyncWrite> BufStream<RW> { - /// Wrap a type in both [`BufWriter`] and [`BufReader`]. + /// Wraps a type in both [`BufWriter`] and [`BufReader`]. /// /// See the documentation for those types and [`BufStream`] for details. pub fn new(stream: RW) -> BufStream<RW> { |