Merge pull request #869 from jimblandy/buf-writer-doc-fix

Fix BufWriter documentation: BufWriters do not flush when dropped.
pull/867/head
Friedel Ziegelmayer 4 years ago committed by GitHub
commit 6a6623cfad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -74,7 +74,8 @@ pin_project! {
/// ///
/// By wrapping the stream with a `BufWriter`, these ten writes are all grouped /// By wrapping the stream with a `BufWriter`, these ten writes are all grouped
/// together by the buffer, and will all be written out in one system call when /// together by the buffer, and will all be written out in one system call when
/// the `stream` is dropped. /// `stream.flush()` completes. (As mentioned above, dropping a `BufWriter`
/// does not flush its buffers, so a `flush` call is essential.)
/// ///
/// [`Write`]: trait.Write.html /// [`Write`]: trait.Write.html
/// [`TcpStream::write`]: ../net/struct.TcpStream.html#method.write /// [`TcpStream::write`]: ../net/struct.TcpStream.html#method.write

Loading…
Cancel
Save