Struct AsyncMapReader

pub struct AsyncMapReader<'a, R> { /* private fields */ }

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

This struct buffers the data read from the underlying reader and applies a mapping function to the data before returning it. It is designed to optimize reads 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 the capacity of the underlying buffer, until the last read operation, where it may be smaller.

Implementations

impl<'a, R> AsyncMapReader<'a, R>

where R: AsyncRead,

pub fn new(reader: R, process_fn: impl MapReadFn + 'a) -> Self

Create a new wrapper around an async reader with a processing function

pub fn with_capacity( reader: R, process_fn: impl MapReadFn + 'a, capacity: usize, ) -> Self

Create a new wrapper with a specific initial buffer capacity

pub fn into_inner(self) -> R

Consume the wrapper and return the inner reader

Trait Implementations

impl<'a, R: AsyncRead> AsyncBufRead for AsyncMapReader<'a, R>

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

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<'a, R> AsyncRead for AsyncMapReader<'a, R>

where R: AsyncRead,

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'__pin, 'a, R> Unpin for AsyncMapReader<'a, R>

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