Struct ReplayStream 

pub struct ReplayStream { /* private fields */ }

A wrapper around a BoxStream that provides bounded sniff buffering for protocol detection. All bytes read during detection are preserved in an internal buffer. After detection completes, subsequent reads are served directly from the underlying stream.

Implementations

impl ReplayStream

pub fn new(stream: BoxStream) -> Self

Creates a new ReplayStream with the default 8 KiB buffer size.

pub fn with_max_buffer(stream: BoxStream, max_buffer: usize) -> Self

Creates a new ReplayStream with a custom maximum buffer size.

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

Returns a reference to the bytes that have been sniffed so far.

pub fn into_inner(self) -> BoxStream

Consumes this ReplayStream and returns the underlying stream.

If detection left buffered bytes unread, they remain available through the returned stream before reads reach the underlying stream.

pub fn finish_sniff(&mut self)

Disables sniffing mode. After this call, reads are served directly from the underlying stream after any unread buffered bytes have been delivered.

pub fn buffered_remaining(&self) -> usize

Returns the number of bytes remaining in the sniff buffer that have not yet been returned to a caller.

Trait Implementations

impl AsyncRead for ReplayStream

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

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for ReplayStream

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<()>>

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<()>>

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, Error>>

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 Debug for ReplayStream

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

Formats the value using the given formatter.