Struct FramedRead 

pub struct FramedRead<R, D> { /* private fields */ }

Async framed reader that applies a Decoder to an AsyncRead source.

Implements Stream where each item is a decoded frame. Data is read from the inner reader into an internal buffer, then the decoder extracts complete frames.

Cancel Safety

poll_next is cancel-safe. Partial data remains in the internal buffer across cancellations. No decoded frame is lost unless it was already yielded.

Implementations

impl<R, D> FramedRead<R, D>

pub fn new(inner: R, decoder: D) -> Self

Creates a new FramedRead with the default buffer capacity.

pub fn with_capacity(inner: R, decoder: D, capacity: usize) -> Self

Creates a new FramedRead with the specified buffer capacity.

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

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

Returns a mutable reference to the underlying reader.

pub fn decoder(&self) -> &D

Returns a reference to the decoder.

pub fn decoder_mut(&mut self) -> &mut D

Returns a mutable reference to the decoder.

pub fn read_buffer(&self) -> &BytesMut

Returns a reference to the read buffer.

pub fn into_inner(self) -> R

Consumes self and returns the inner reader.

pub fn into_parts(self) -> (R, D, BytesMut)

Consumes self and returns the inner reader, decoder, and buffer.

Trait Implementations

impl<R: Debug, D: Debug> Debug for FramedRead<R, D>

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

Formats the value using the given formatter.

impl<R, D> Stream for FramedRead<R, D>

where R: AsyncRead + Unpin, D: Decoder + Unpin,

type Item = Result<<D as Decoder>::Item, <D as Decoder>::Error>

The type of values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.