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

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

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

Wraps a writer and buffers its output.

It can be excessively inefficient to work directly with something that implements `Write`. For example, every call to `write` on `TcpStream` results in a system call. A `BufWriter` keeps an in-memory buffer of data and writes it to an underlying writer in large, infrequent batches.

`BufWriter` can improve the speed of programs that make small and repeated write calls to the same file or network socket. It does not help when writing very large amounts at once, or writing just one or a few times. It also provides no advantage when writing to a destination that is in memory, like a `Vec<u8>`.

When the `BufWriter` is dropped, the contents of its buffer will be written out. However, any errors that happen in the process of flushing the buffer when the writer is dropped will be ignored. Code that wishes to handle such errors must manually call `flush` before the writer is dropped.

# Examples

Let's write the numbers one through ten to a `TcpStream`:

    use std::io::prelude::*;
    use std::net::TcpStream;

    let mut stream = TcpStream::connect("127.0.0.1:34254").unwrap();

    for i in 0..10 {
        stream.write(&[i+1]).unwrap();
    }Run

Because we're not buffering, we write each one in turn, incurring the overhead of a system call per byte written. We can fix this with a `BufWriter`:

    use std::io::prelude::*;
    use std::io::BufWriter;
    use std::net::TcpStream;

    let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());

    for i in 0..10 {
        stream.write(&[i+1]).unwrap();
    }Run

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 the `stream` is dropped.

## Methods

### `impl<W: Write> BufWriter<W>`[src]

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

### Important traits for BufWriter<W>

`impl<W: Write> Write for BufWriter<W>`
`pub fn new(inner: W) -> BufWriter<W>`[src]

Creates a new `BufWriter` with a default buffer capacity. The default is currently 8 KB, but may change in the future.

# Examples

    use std::io::BufWriter;
    use std::net::TcpStream;

    let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());Run

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

### Important traits for BufWriter<W>

`impl<W: Write> Write for BufWriter<W>`
`pub fn with_capacity(cap: usize, inner: W) -> BufWriter<W>`[src]

Creates a new `BufWriter` with the specified buffer capacity.

# Examples

Creating a buffer with a buffer of a hundred bytes.

    use std::io::BufWriter;
    use std::net::TcpStream;

    let stream = TcpStream::connect("127.0.0.1:34254").unwrap();
    let mut buffer = BufWriter::with_capacity(100, stream);Run

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

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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::io::BufWriter;
    use std::net::TcpStream;

    let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());

    // we can use reference just like buffer
    let reference = buffer.get_ref();Run

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

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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.

It is inadvisable to directly write to the underlying writer.

# Examples

    use std::io::BufWriter;
    use std::net::TcpStream;

    let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());

    // we can use reference just like buffer
    let reference = buffer.get_mut();Run

####
ⓘImportant traits for &'a [u8]

### Important traits for &'a [u8]

`impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]`
`pub fn buffer(&self) -> &[u8]`[src]

🔬 This is a nightly-only experimental API. (`bufreader_buffer` #45323)

Returns a reference to the internally buffered data.

# Examples

    use std::io::BufWriter;
    use std::net::TcpStream;

    let buf_writer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());

    // See how many bytes are currently buffered
    let bytes_buffered = buf_writer.buffer().len();Run

#### `pub fn into_inner(self) -> Result<W, IntoInnerError<BufWriter<W>>>`[src]

Unwraps this `BufWriter`, returning the underlying writer.

The 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::io::BufWriter;
    use std::net::TcpStream;

    let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());

    // unwrap the TcpStream and flush the buffer
    let stream = buffer.into_inner().unwrap();Run

## Trait Implementations

### `impl<W: Write> Write for BufWriter<W>`[src]

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

Write a buffer into this writer, 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 writer. 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 &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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 + Seek> Seek for BufWriter<W>`[src]

#### `fn seek(&mut self, pos: SeekFrom) -> Result<u64>`[src]

Seek to the offset, in bytes, in the underlying writer.

Seeking always writes out the internal buffer before seeking.

### `impl<W: Write> Debug for BufWriter<W> where
W: Debug,` [src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl<W: Write> Drop for BufWriter<W>`[src]

#### `fn drop(&mut self)`[src]

Executes the destructor for this type. Read more

## Auto Trait Implementations

### `impl<W> Send for BufWriter<W> where
W: Send,`

### `impl<W> Sync for BufWriter<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 &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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 &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ 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`)