Struct tokio_util::io::InspectReader

pub struct InspectReader<R, F> { /* private fields */ }

Available on crate feature io only.

An adapter that lets you inspect the data that’s being read.

This is useful for things like hashing data as it’s read in.

Implementations

impl<R, F> InspectReader<R, F>

pub fn new(reader: R, f: F) -> InspectReader<R, F>

where R: AsyncRead, F: FnMut(&[u8]),

Create a new InspectReader, wrapping reader and calling f for the new data supplied by each read call.

The closure will only be called with an empty slice if the inner reader returns without reading data into the buffer. This happens at EOF, or if poll_read is called with a zero-size buffer.

pub fn into_inner(self) -> R

Consumes the InspectReader, returning the wrapped reader

Trait Implementations

impl<R: AsyncRead, F: FnMut(&[u8])> AsyncRead for InspectReader<R, F>

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

Attempts to read from the AsyncRead into buf.

impl<R: AsyncWrite, F> AsyncWrite for InspectReader<R, F>

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

Attempt to write bytes from buf into the object.

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

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

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

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

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<'__pin, R, F> Unpin for InspectReader<R, F>

where __Origin<'__pin, R, F>: Unpin,