Struct tokio_util::codec::FramedRead

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

A Stream of messages decoded from an AsyncRead.

For examples of how to use FramedRead with a codec, see the examples on the codec module.

Cancellation safety

• tokio_stream::StreamExt::next: This method is cancel safe. The returned future only holds onto a reference to the underlying stream, so dropping it will never lose a value.

Implementations

impl<T, D> FramedRead<T, D>

where T: AsyncRead, D: Decoder,

pub fn new(inner: T, decoder: D) -> FramedRead<T, D>

Creates a new FramedRead with the given decoder.

pub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D>

Creates a new FramedRead with the given decoder and a buffer of capacity initial size.

impl<T, D> FramedRead<T, D>

pub fn get_ref(&self) -> &T

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 T

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 get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Returns a pinned 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) -> T

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) -> &D

Returns a reference to the underlying decoder.

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

Returns a mutable reference to the underlying decoder.

pub fn map_decoder<C, F>(self, map: F) -> FramedRead<T, C>

where F: FnOnce(D) -> C,

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

pub fn decoder_pin_mut(self: Pin<&mut Self>) -> &mut D

Returns a mutable reference to the underlying decoder.

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.

Trait Implementations

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<T, I, D> Sink<I> for FramedRead<T, D>

where T: Sink<I>,

type Error = <T as Sink<I>>::Error

The type of value produced by the sink when an error occurs.

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

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

Flush any remaining output from this sink.

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

Flush any remaining output and close this sink, if necessary.

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

where T: AsyncRead, D: Decoder,

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

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, 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<'__pin, T, D> Unpin for FramedRead<T, D>

where __Origin<'__pin, T, D>: Unpin,