Struct AsyncMapWriter

pub struct AsyncMapWriter<'a, W> { /* private fields */ }

A wrapper around an AsyncWrite that allows for data processing before the actual I/O operation.

This struct buffers the data written to the underlying writer and applies a mapping function to the data before writing it out. It is designed to optimize writes by using a buffer of a specified size (default is 8KB).

The buffer size also acts as a threshold for the length of data passed to the mapping function, and will be gauranteed to be equal to or less than the specified capacity, unless the function modifies the buffer capacity itself.

Implementations

impl<'a, W: AsyncWrite> AsyncMapWriter<'a, W>

pub fn new(writer: W, process_fn: impl MapWriteFn + 'a) -> Self

Creates a new AsyncMapWriter with a default buffer size of 8KB.

This function initializes the writer with the provided process_fn to map the data before writing.

pub fn with_capacity( writer: W, process_fn: impl MapWriteFn + 'a, capacity: usize, ) -> Self

Creates a new AsyncMapWriter with a specified buffer capacity.

This function initializes the writer with the provided process_fn to map the data before writing.

pub fn into_inner(self) -> W

Consumes the AsyncMapWriter and returns the underlying writer.

Trait Implementations

impl<W: AsyncWrite> AsyncWrite for AsyncMapWriter<'_, W>

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

Attempt to write bytes from buf into the object.

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

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

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<'__pin, 'a, W> Unpin for AsyncMapWriter<'a, W>

where PinnedFieldsOf<__Origin<'__pin, 'a, W>>: Unpin,