Struct BufWriter 

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

Async buffered writer.

Wraps an AsyncWrite and provides buffering for more efficient writes. Uses an internal buffer to reduce the number of underlying write calls.

Example

use asupersync::io::BufWriter;

let writer = Vec::new();
let mut buf_writer = BufWriter::new(writer);

// Write to the buffered writer
// Data is batched and written when buffer fills or flush is called

Flushing

Data is not written to the underlying writer until:

• The internal buffer is full
• flush() is called
• shutdown() is called
• A write exceeds the buffer capacity

Always ensure you flush or shutdown the writer to avoid data loss.

Implementations

impl<W> BufWriter<W>

pub fn new(inner: W) -> Self

Creates a new BufWriter with the default buffer capacity (8192 bytes).

pub fn with_capacity(capacity: usize, inner: W) -> Self

Creates a new BufWriter with the specified buffer capacity.

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

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

Returns a mutable reference to the underlying writer.

Note: Writing directly to the inner writer may cause data ordering issues if the buffer contains unflushed data.

pub fn into_inner(self) -> W

Consumes the BufWriter and returns the underlying writer.

Warning: Any buffered data that has not been flushed will be lost.

pub fn buffer(&self) -> &[u8]

Returns the current buffer contents.

This is the data that has been written to the BufWriter but has not yet been flushed to the underlying writer.

pub fn capacity(&self) -> usize

Returns the capacity of the internal buffer.

Trait Implementations

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

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write data from buf.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write data from multiple buffers (vectored I/O).

fn is_write_vectored(&self) -> bool

Returns whether this writer has efficient vectored writes.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush buffered data.

fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to shutdown the writer.

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

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

Formats the value using the given formatter.