about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorMark Rousskov <mark.simulacrum@gmail.com>2018-07-26 09:18:39 -0600
committerGitHub <noreply@github.com>2018-07-26 09:18:39 -0600
commit091a10e0eb5a86ace454b23c7ed2f1aaefb5b969 (patch)
tree569e6f3ae76635b0d291e878945bc58d88868fa7 /src/libstd
parentcc7a82659404886ed0992dd085a7c5547ba66020 (diff)
parentabb704ec78bd69c0911c5f7711646d443da4c84d (diff)
downloadrust-091a10e0eb5a86ace454b23c7ed2f1aaefb5b969.tar.gz
rust-091a10e0eb5a86ace454b23c7ed2f1aaefb5b969.zip
Rollup merge of #52718 - fintelia:patch-2, r=cramertj
State default capacity for BufReader/BufWriter

Addresses #52513
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/io/buffered.rs6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs
index 189569683a9..2babf508fdc 100644
--- a/src/libstd/io/buffered.rs
+++ b/src/libstd/io/buffered.rs
@@ -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
     ///