review 1: talk about using BufReader to change the capacity

tokio-rs · Mar 23, 2023 · f30128d · f30128d
1 parent 4a4ecfa
commit f30128d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/tokio/src/io/util/copy.rs b/tokio/src/io/util/copy.rs
@@ -160,13 +160,15 @@ cfg_io_util! {
     ///
     /// This is an asynchronous version of [`std::io::copy`][std].
     ///
-    /// A heap-allocated buffer with 8 KB is created to take data from the
-    /// reader to the writer, check [`copy_buf`] if you want an alternative
-    /// for [`AsyncBufRead`].
+    /// A heap-allocated copy buffer with 8 KB is created to take data from the
+    /// reader to the writer, check [`copy_buf`] if you want an alternative for
+    /// [`AsyncBufRead`], you can use it with [`BufReader`] to change the copy
+    /// buffer capacity.
     ///
     /// [std]: std::io::copy
     /// [`copy_buf`]: crate::io::copy_buf
     /// [`AsyncBufRead`]: crate::io::AsyncBufRead
+    /// [`BufReader`]: crate::io::BufReader
     ///
     /// # Errors
     ///

diff --git a/tokio/src/io/util/copy_buf.rs b/tokio/src/io/util/copy_buf.rs
@@ -29,7 +29,7 @@ cfg_io_util! {
     /// On success, the total number of bytes that were copied from `reader` to
     /// `writer` is returned.
     ///
-    /// This is a [`tokio::io::copy`] alternative for [`AsyncBufRead`] readers,
+    /// This is a [`tokio::io::copy`] alternative for [`AsyncBufRead`] readers
     /// with no extra buffer allocation, since [`AsyncBufRead`] allow access
     /// to the reader's inner buffer.
     ///