Struct ntex::io::utils::Framed

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

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> where
    U: Decoder + Encoder, 

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 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 as Decoder>::Item>, Either<<U as Decoder>::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 as Encoder>::Error, Error>>

Serialize item and Write to the inner buffer

Trait Implementations

impl<U> Debug for Framed<U> where
    U: Debug, 

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

Formats the value using the given formatter.