]> git.lizzy.rs Git - rust.git/commitdiff
State default capacity for BufReader/BufWriter
authorJonathan Behrens <fintelia@gmail.com>
Wed, 25 Jul 2018 23:42:59 +0000 (00:42 +0100)
committerJonathan Behrens <fintelia@gmail.com>
Wed, 25 Jul 2018 23:49:35 +0000 (00:49 +0100)
src/libstd/io/buffered.rs

index 189569683a9cf78fad5f243f5e33afc1057e48e3..2babf508fdcc3b524fc0f12e9e6717cdb2b78ad8 100644 (file)
@@ -61,7 +61,8 @@ 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. The default is currently 8 KB,
+    /// but may change in the future.
     ///
     /// # Examples
     ///
@@ -454,7 +455,8 @@ 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. The default is currently 8 KB,
+    /// but may change in the future.
     ///
     /// # Examples
     ///