Struct Framed

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

A unified interface to an underlying I/O object, using the Encoder and Decoder traits to encode and decode frames. Framed is heavily optimized for streaming io.

Implementations

impl<U> Framed<U>

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

where IoBoxed: From<Io>,

Provides an interface for reading and writing to Io object, using Decode and Encode traits of 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)

Return inner types of framed object

impl<U> Framed<U>

where U: Decoder + Encoder,

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

Wake write task and instruct to flush data.

This is async version of .poll_flush() method.

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

Shut down io stream

impl<U> Framed<U>

where U: Decoder,

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

Read incoming io stream and decode codec item.

impl<U> Framed<U>

where U: Encoder,

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

Serialize item and Write to the inner buffer

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.