std::io::LineWriter - Rust
Description: API documentation for the Rust `LineWriter` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, LineWriter

# 1.0.0[−][src]Struct std::io::LineWriter

    pub struct LineWriter<W: Write> { /* fields omitted */ }

Wraps a writer and buffers output to it, flushing whenever a newline (`0x0a`, `'\n'`) is detected.

The `BufWriter` struct wraps a writer and buffers its output. But it only does this batched write when it goes out of scope, or when the internal buffer is full. Sometimes, you'd prefer to write each line as it's 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.

If there's still a partial line in the buffer when the `LineWriter` is dropped, it will flush those contents.

# Examples

We can use `LineWriter` to write one line at a time, significantly reducing the number of actual writes to the file.

    use std::fs::{self, File};
    use std::io::prelude::*;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let road_not_taken = b"I shall be telling this with a sigh
    Somewhere ages and ages hence:
    Two roads diverged in a wood, and I -
    I took the one less traveled by,
    And that has made all the difference.";

        let file = File::create("poem.txt")?;
        let mut file = LineWriter::new(file);

        file.write_all(b"I shall be telling this with a sigh")?;

        // No bytes are written until a newline is encountered (or
        // the internal buffer is filled).
        assert_eq!(fs::read_to_string("poem.txt")?, "");
        file.write_all(b"\n")?;
        assert_eq!(
            fs::read_to_string("poem.txt")?,
            "I shall be telling this with a sigh\n",
        );

        // Write the rest of the poem.
        file.write_all(b"Somewhere ages and ages hence:
    Two roads diverged in a wood, and I -
    I took the one less traveled by,
    And that has made all the difference.")?;

        // The last line of the poem doesn't end in a newline, so
        // we have to flush or drop the `LineWriter` to finish
        // writing.
        file.flush()?;

        // Confirm the whole poem was written.
        assert_eq!(fs::read("poem.txt")?, &road_not_taken[..]);
        Ok(())
    }Run

## Methods

###

`impl<W: Write> LineWriter<W>`

[src]

####
ⓘImportant traits for LineWriter<W>

### Important traits for LineWriter<W>

`impl<W: Write> Write for LineWriter<W>`

`pub fn new(inner: W) -> LineWriter<W>`

[src]

Creates a new `LineWriter`.

# Examples

    use std::fs::File;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let file = File::create("poem.txt")?;
        let file = LineWriter::new(file);
        Ok(())
    }Run

####
ⓘImportant traits for LineWriter<W>

### Important traits for LineWriter<W>

`impl<W: Write> Write for LineWriter<W>`

`pub fn with_capacity(cap: usize, inner: W) -> LineWriter<W>`

[src]

Creates a new `LineWriter` with a specified capacity for the internal buffer.

# Examples

    use std::fs::File;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let file = File::create("poem.txt")?;
        let file = LineWriter::with_capacity(100, file);
        Ok(())
    }Run

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`pub fn get_ref(&self) -> &W`

[src]

Gets a reference to the underlying writer.

# Examples

    use std::fs::File;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let file = File::create("poem.txt")?;
        let file = LineWriter::new(file);

        let reference = file.get_ref();
        Ok(())
    }Run

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`pub fn get_mut(&mut self) -> &mut W`

[src]

Gets a mutable reference to the underlying writer.

Caution must be taken when calling methods on the mutable reference returned as extra writes could corrupt the output stream.

# Examples

    use std::fs::File;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let file = File::create("poem.txt")?;
        let mut file = LineWriter::new(file);

        // we can use reference just like file
        let reference = file.get_mut();
        Ok(())
    }Run

####

`pub fn into_inner(self) -> Result<W, IntoInnerError<LineWriter<W>>>`

[src]

Unwraps this `LineWriter`, returning the underlying writer.

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

    use std::fs::File;
    use std::io::LineWriter;

    fn main() -> std::io::Result<()> {
        let file = File::create("poem.txt")?;

        let writer: LineWriter<File> = LineWriter::new(file);

        let file: File = writer.into_inner()?;
        Ok(())
    }Run

## Trait Implementations

###

`impl<W: Write> Write for LineWriter<W>`

[src]

####

`fn write(&mut self, buf: &[u8]) -> Result<usize>`

[src]

Write a buffer into this object, returning how many bytes were written. Read more

####

`fn flush(&mut self) -> Result<()>`

[src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

####

`fn write_all(&mut self, buf: &[u8]) -> Result<()>`

[src]

Attempts to write an entire buffer into this write. Read more

####

`fn write_fmt(&mut self, fmt: Arguments) -> Result<()>`

[src]

Writes a formatted string into this writer, returning any error encountered. Read more

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn by_ref(&mut self) -> &mut Self where Self: Sized,`

[src]

Creates a "by reference" adaptor for this instance of `Write`. Read more

###

`impl<W: Write> Debug for LineWriter<W> where W: Debug,`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl<W> Send for LineWriter<W> where W: Send,`

###

`impl<W> Sync for LineWriter<W> where W: Sync,`

## Blanket Implementations

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)