[][src]Struct tokio_util::codec::Framed

pub struct Framed<T, U> { /* fields omitted */ }
This is supported on crate feature codec only.

A unified Stream and Sink interface to an underlying I/O object, using the Encoder and Decoder traits to encode and decode frames.

You can create a Framed instance by using the Decoder::framed adapter, or by using the new function seen below.

Implementations

impl<T, U> Framed<T, U> where
    T: AsyncRead + AsyncWrite
[src]

pub fn new(inner: T, codec: U) -> Framed<T, U>[src]

This is supported on crate feature codec only.

Provides a Stream and Sink interface for reading and writing to this I/O object, using Decoder and Encoder to read and write the raw data.

Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called "frames". This method layers framing on top of an I/O object, by using the codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.

This function returns a single object that is both Stream and Sink; grouping this into a single object is often useful for layering things like gzip or TLS, which require both read and write access to the underlying object.

If you want to work more directly with the streams and sink, consider calling split on the Framed returned by this method, which will break them into separate objects, allowing them to interact more easily.

pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U>[src]

This is supported on crate feature codec only.

Provides a Stream and Sink interface for reading and writing to this I/O object, using Decoder and Encoder to read and write the raw data, with a specific read buffer initial capacity.

Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called "frames". This method layers framing on top of an I/O object, by using the codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.

This function returns a single object that is both Stream and Sink; grouping this into a single object is often useful for layering things like gzip or TLS, which require both read and write access to the underlying object.

If you want to work more directly with the streams and sink, consider calling split on the Framed returned by this method, which will break them into separate objects, allowing them to interact more easily.

impl<T, U> Framed<T, U>[src]

pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>[src]

This is supported on crate feature codec only.

Provides a Stream and Sink interface for reading and writing to this I/O object, using Decoder and Encoder to read and write the raw data.

Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called "frames". This method layers framing on top of an I/O object, by using the Codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.

This function returns a single object that is both Stream and Sink; grouping this into a single object is often useful for layering things like gzip or TLS, which require both read and write access to the underlying object.

This objects takes a stream and a readbuffer and a writebuffer. These field can be obtained from an existing Framed with the into_parts method.

If you want to work more directly with the streams and sink, consider calling split on the Framed returned by this method, which will break them into separate objects, allowing them to interact more easily.

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

This is supported on crate feature codec only.

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

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]

This is supported on crate feature codec only.

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

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 codec(&self) -> &U[src]

This is supported on crate feature codec only.

Returns a reference to the underlying codec wrapped by Framed.

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

pub fn codec_mut(&mut self) -> &mut U[src]

This is supported on crate feature codec only.

Returns a mutable reference to the underlying codec wrapped by Framed.

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

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

This is supported on crate feature codec only.

Returns a reference to the read buffer.

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

This is supported on crate feature codec only.

Returns a mutable reference to the read buffer.

pub fn into_inner(self) -> T[src]

This is supported on crate feature codec only.

Consumes the Framed, 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 into_parts(self) -> FramedParts<T, U>[src]

This is supported on crate feature codec only.

Consumes the Framed, returning its underlying I/O stream, the buffer with unprocessed data, and the codec.

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.

Trait Implementations

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

impl<T, I, U> Sink<I> for Framed<T, U> where
    T: AsyncWrite,
    U: Encoder<I>,
    U::Error: From<Error>, 
[src]

type Error = U::Error

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

impl<T, U> Stream for Framed<T, U> where
    T: AsyncRead,
    U: Decoder
[src]

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

Values yielded by the stream.

impl<'__pin, T, U> Unpin for Framed<T, U> where
    __Origin<'__pin, T, U>: Unpin
[src]

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Framed<T, U> where
    T: RefUnwindSafe,
    U: RefUnwindSafe

impl<T, U> Send for Framed<T, U> where
    T: Send,
    U: Send

impl<T, U> Sync for Framed<T, U> where
    T: Sync,
    U: Sync

impl<T, U> UnwindSafe for Framed<T, U> where
    T: UnwindSafe,
    U: 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