Struct FramedRead

pub struct FramedRead<IO, Codec> { /* private fields */ }

Implementations

impl<IO, Codec> FramedRead<IO, Codec>

pub fn new(io: IO, decoder: Codec) -> Self

pub fn with_capacity(io: IO, codec: Codec, capacity: usize) -> Self

pub fn get_ref(&self) -> &IO

Returns a reference to the underlying I/O stream wrapped by FramedRead.

Note that care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

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

Returns a mutable reference to the underlying I/O stream wrapped by FramedRead.

Note that care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

pub fn into_inner(self) -> IO

Consumes the FramedRead, returning its underlying I/O stream.

Note that care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

pub fn decoder(&self) -> &Codec

Returns a reference to the underlying decoder.

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

Returns a mutable reference to the underlying decoder.

pub fn map_decoder<CodecNew, F>(self, map: F) -> FramedRead<IO, CodecNew>

where F: FnOnce(Codec) -> CodecNew,

Maps the decoder D to C, preserving the read buffer wrapped by Framed.

pub fn read_buffer(&self) -> &BytesMut

Returns a reference to the read buffer.

pub fn read_buffer_mut(&mut self) -> &mut BytesMut

Returns a mutable reference to the read buffer.

pub fn read_state_mut(&mut self) -> (&mut IO, &mut BytesMut)

Returns io and a mutable reference to the read buffer.

pub async fn next_with<C: Decoder>( &mut self, codec: &mut C, ) -> Option<Result<C::Item, C::Error>>

where IO: AsyncReadRent,

Equivalent to Stream::next but with custom codec.

pub fn peek_data(&mut self) -> impl Future<Output = Result<&mut [u8]>>

where IO: AsyncReadRent,

Await some new data. Useful to do read timeout.

Trait Implementations

impl<IO: AsyncReadRent, Codec> AsyncReadRent for FramedRead<IO, Codec>

async fn read<T: IoBufMut>(&mut self, buf: T) -> BufResult<usize, T>

Same as read(2)

async fn readv<T: IoVecBufMut>(&mut self, buf: T) -> BufResult<usize, T>

Same as readv(2)

impl<T, D> Debug for FramedRead<T, D>

where T: Debug, D: Debug,

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

Formats the value using the given formatter.

impl<IO, Codec> Stream for FramedRead<IO, Codec>

where IO: AsyncReadRent, Codec: Decoder,

type Item = <FramedInner<IO, Codec, ReadState> as Stream>::Item

Values yielded by the stream.

async fn next(&mut self) -> Option<Self::Item>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.

impl<Codec: Decoder, IO: AsyncReadRent, AnyCodec> StreamWithCodec<Codec> for FramedRead<IO, AnyCodec>

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

async fn next_with<'a>(&'a mut self, codec: &'a mut Codec) -> Option<Self::Item>