mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document when LineWriter flushes; document errors for into_inner.

Browse Source 
Fixes https://github.com/rust-lang/rust/issues/42468.
This commit is contained in:
Corey Farwell 2018-01-02 13:30:44 -08:00
parent a37126b90c
commit f3ef077b91
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/libstd/io/buffered.rs
View File

@ -486,6 +486,10 @@ impl<W: Write> BufWriter<W> {
///
/// The buffer is written out before returning the writer.
///
/// # Errors
///
/// An `Err` will be returned if an error occurs while flushing the buffer.
///
/// # Examples
///
/// ```no_run
@ -650,6 +654,9 @@ impl<W> fmt::Display for IntoInnerError<W> {
/// completed, rather than the entire buffer at once. Enter `LineWriter`. It
/// does exactly that.
///
/// Like [`BufWriter`], a `LineWriter`’s buffer will also be flushed when the
/// `LineWriter` goes out of scope or when its internal buffer is full.
///
/// [bufwriter]: struct.BufWriter.html
///
/// If there's still a partial line in the buffer when the `LineWriter` is
@ -785,6 +792,10 @@ impl<W: Write> LineWriter<W> {
///
/// The internal buffer is written out before returning the writer.
///
// # Errors
///
/// An `Err` will be returned if an error occurs while flushing the buffer.
///
/// # Examples
///
/// ```