Struct Framed 

pub struct Framed<U> { /* private fields */ }

A codec-driven interface to an underlying I/O stream.

Uses the Encoder and Decoder traits to encode and decode frames.

Implementations

impl<U> Framed<U>

pub fn new<Io>(io: Io, codec: U) -> Framed<U>

where IoBoxed: From<Io>,

Wraps an I/O object with a codec.

pub fn get_io(&self) -> &IoBoxed

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

pub fn get_codec(&self) -> &U

Returns a reference to the underlying codec.

pub fn into_inner(self) -> (IoBoxed, U)

Returns the underlying I/O object and codec.

impl<U> Framed<U>

where U: Decoder + Encoder,

pub async fn flush(&self, full: bool) -> Result<()>

Flushes encoded data to the transport.

If full is true, waits until all buffered data has been written.

pub async fn shutdown(&self) -> Result<()>

Gracefully shuts down the I/O stream.

impl<U> Framed<U>

where U: Decoder,

pub async fn recv(&self) -> Result<Option<U::Item>, Either<U::Error, Error>>

Reads and decodes the next item.

Returns Ok(None) when the connection can no longer produce another complete item and no error was recorded. Codec errors are returned in Either::Left; dispatcher timeouts and connection errors from the transport, a filter, or shutdown are returned in Either::Right.

impl<U> Framed<U>

where U: Encoder,

pub async fn send( &self, item: <U as Encoder>::Item, ) -> Result<(), Either<U::Error, Error>>

Encodes an item and fully flushes it to the transport.

Codec errors are returned in Either::Left; connection errors from the transport, a filter, or shutdown, including an expired write timeout, are returned in Either::Right.

Trait Implementations

impl<U> Debug for Framed<U>

where U: Debug,

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

Formats the value using the given formatter.