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

Resolves #55546
This commit is contained in:
Chris Gregory 2019-03-27 22:11:13 -04:00
parent 07d350897c
commit ffaa5c904e

View File

@ -21,6 +21,10 @@
/// 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