Struct BufWriter

pub struct BufWriter<W> { /* private fields */ }

Wraps a writer and buffers its output.

It can be excessively inefficient to work directly with something that implements AsyncWrite. A BufWriter<W> keeps an in-memory buffer of data and writes it to an underlying writer in large, infrequent batches. BufWriter<W> 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>.

Dropping BufWriter<W> also discards any bytes left in the buffer, so it is critical to call flush before BufWriter<W> is dropped. Calling flush ensures that the buffer is empty and thus no data is lost.

Implementations

impl<W> BufWriter<W>

pub fn new(writer: W) -> Self

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

pub fn with_capacity(cap: usize, writer: W) -> Self

Creates a new BufWriter with the specified buffer capacity.

Trait Implementations

impl<W: AsyncWrite> AsyncWrite for BufWriter<W>

async fn write<T: IoBuf>(&mut self, buf: T) -> BufResult<usize, T>

Write some bytes from the buffer into this source and return a BufResult, consisting of the buffer and a usize indicating how many bytes were written.

async fn write_vectored<T: IoVectoredBuf>( &mut self, buf: T, ) -> BufResult<usize, T>

Like write, except that it write bytes from a buffer implements IoVectoredBuf into the source.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

async fn shutdown(&mut self) -> Result<()>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

impl<W: Debug> Debug for BufWriter<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W> IntoInner for BufWriter<W>

type Inner = W

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.