[][src]Struct tokio_util::codec::FramedRead

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

A Stream of messages decoded from an AsyncRead.

Methods

impl<T, D> FramedRead<T, D> where
    T: AsyncRead,
    D: Decoder
[src]

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

Creates a new FramedRead with the given decoder.

impl<T, D> FramedRead<T, D>[src]

pub fn get_ref(&self) -> &T[src]

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[src]

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) -> T[src]

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[src]

Returns a reference to the underlying decoder.

pub fn decoder_mut(&mut self) -> &mut D[src]

Returns a mutable reference to the underlying decoder.

pub fn read_buffer(&self) -> &BytesMut[src]

Returns a reference to the read buffer.

Trait Implementations

impl<T, D> Debug for FramedRead<T, D> where
    T: Debug,
    D: Debug
[src]

impl<T, I, D> Sink<I> for FramedRead<T, D> where
    T: Sink<I>, 
[src]

type Error = T::Error

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

impl<T, D> Stream for FramedRead<T, D> where
    T: AsyncRead,
    D: Decoder
[src]

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

Values yielded by the stream.

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

Auto Trait Implementations

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

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

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

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

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future