Struct tokio_util::codec::FramedRead

source ·
pub struct FramedRead<T, D> { /* private fields */ }
Expand description

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§

source§

impl<T, D> FramedRead<T, D>
where T: AsyncRead, D: Decoder,

source

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

Creates a new FramedRead with the given decoder.

source

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.

source§

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

source

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.

source

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.

source

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.

source

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.

source

pub fn decoder(&self) -> &D

Returns a reference to the underlying decoder.

source

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

Returns a mutable reference to the underlying decoder.

source

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.

source

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

Returns a mutable reference to the underlying decoder.

source

pub fn read_buffer(&self) -> &BytesMut

Returns a reference to the read buffer.

source

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

Returns a mutable reference to the read buffer.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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.
source§

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

Attempts to prepare the Sink to receive a value. Read more
source§

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(())). Read more
source§

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

Flush any remaining output from this sink. Read more
source§

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

Flush any remaining output and close this sink, if necessary. Read more
source§

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.
source§

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. Read more
source§

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

Returns the bounds on the remaining length of the stream. Read more
source§

impl<'__pin, T, D> Unpin for FramedRead<T, D>
where __Origin<'__pin, T, D>: Unpin,

Auto Trait Implementations§

§

impl<T, D> Freeze for FramedRead<T, D>
where T: Freeze, D: Freeze,

§

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

§

impl<T, D> Send for FramedRead<T, D>
where T: Send, D: Send,

§

impl<T, D> Sync for FramedRead<T, D>
where T: Sync, D: Sync,

§

impl<T, D> UnwindSafe for FramedRead<T, D>
where T: UnwindSafe, D: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

§

type Ok = T

The type of successful values yielded by this future
§

type Error = E

The type of failures yielded by this future
source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more