Document that std::io::BufReader discards contents on drop

Resolves rust-lang#55546
czipperz · Mar 28, 2019 · ffaa5c9 · ffaa5c9
1 parent 07d3508
commit ffaa5c9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs
@@ -21,6 +21,10 @@ use crate::memchr;
 /// times. It also provides no advantage when reading from a source that is
 /// already in memory, like a `Vec<u8>`.
 ///
+/// When the `BufReader` is dropped, the contents of its buffer will be
+/// discarded. Creating multiple instances of a `BufReader` on the same
+/// stream can cause data loss.
+///
 /// [`Read`]: ../../std/io/trait.Read.html
 /// [`TcpStream::read`]: ../../std/net/struct.TcpStream.html#method.read
 /// [`TcpStream`]: ../../std/net/struct.TcpStream.html