[][src]Struct tokio_util::codec::FramedWrite

pub struct FramedWrite<T, E> { /* fields omitted */ }

A Sink of frames encoded to an AsyncWrite.

Methods

impl<T, E> FramedWrite<T, E> where
    T: AsyncWrite,
    E: Encoder
[src]

pub fn new(inner: T, encoder: E) -> FramedWrite<T, E>[src]

Creates a new FramedWrite with the given encoder.

impl<T, E> FramedWrite<T, E>[src]

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

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

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 FramedWrite.

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 FramedWrite, 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 encoder(&self) -> &E[src]

Returns a reference to the underlying decoder.

pub fn encoder_mut(&mut self) -> &mut E[src]

Returns a mutable reference to the underlying decoder.

Trait Implementations

impl<T, U> Debug for FramedWrite<T, U> where
    T: Debug,
    U: Debug
[src]

impl<T, I, E> Sink<I> for FramedWrite<T, E> where
    T: AsyncWrite,
    E: Encoder<Item = I>,
    E::Error: From<Error>, 
[src]

type Error = E::Error

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

impl<T, D> Stream for FramedWrite<T, D> where
    T: Stream
[src]

type Item = T::Item

Values yielded by the stream.

impl<'__pin, T, E> Unpin for FramedWrite<T, E> where
    __Origin<'__pin, T, E>: Unpin
[src]

Auto Trait Implementations

impl<T, E> RefUnwindSafe for FramedWrite<T, E> where
    E: RefUnwindSafe,
    T: RefUnwindSafe

impl<T, E> Send for FramedWrite<T, E> where
    E: Send,
    T: Send

impl<T, E> Sync for FramedWrite<T, E> where
    E: Sync,
    T: Sync

impl<T, E> UnwindSafe for FramedWrite<T, E> where
    E: 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