Struct ntex_codec::Framed

pub struct Framed<T, 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<T, U> Framed<T, U> where
    T: AsyncRead + AsyncWrite,
    U: Decoder + Encoder, 

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

Provides an interface for reading and writing to Io object, using Decode and Encode traits of codec.

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.

impl<T, U> Framed<T, U>

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

Construct Framed object parts.

pub fn get_codec(&self) -> &U

Returns a reference to the underlying codec.

pub fn get_codec_mut(&mut self) -> &mut U

Returns a mutable reference to the underlying codec.

pub fn get_ref(&self) -> &T

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

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 read_buf(&mut self) -> &mut BytesMut

Get read buffer.

pub fn write_buf(&mut self) -> &mut BytesMut

Get write buffer.

pub fn is_write_buf_empty(&self) -> bool

Check if write buffer is empty.

pub fn is_write_buf_full(&self) -> bool

Check if write buffer is full.

pub fn is_closed(&self) -> bool

Check if framed object is closed

pub fn into_framed<U2>(self, codec: U2) -> Framed<T, U2>

Consume the Frame, returning Frame with different codec.

pub fn map_io<F, T2>(self, f: F) -> Framed<T2, U> where
    F: Fn(T) -> T2, 

Consume the Frame, returning Frame with different io.

pub fn map_codec<F, U2>(self, f: F) -> Framed<T, U2> where
    F: Fn(U) -> U2, 

Consume the Frame, returning Frame with different codec.

pub fn into_parts(self) -> FramedParts<T, U>

Consumes the Frame, 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.

impl<T, U> Framed<T, U> where
    T: AsyncWrite + Unpin,
    U: Encoder, 

pub fn write(
    &mut self,
    item: <U as Encoder>::Item
) -> Result<(), <U as Encoder>::Error>

Serialize item and Write to the inner buffer

pub fn is_write_ready(&self) -> bool

Check if framed is able to write more data.

Framed object considers ready if there is free space in write buffer.

pub fn flush(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Flush write buffer to underlying I/O stream.

impl<T, U> Framed<T, U> where
    T: AsyncRead + AsyncWrite + Unpin, 

pub fn close(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>

Flush write buffer and shutdown underlying I/O stream.

Close method shutdown write side of a io object and then reads until disconnect or error, high level code must use timeout for close operation.

impl<T, U> Framed<T, U> where
    T: AsyncRead + Unpin,
    U: Decoder, 

pub fn next_item(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Option<Result<<U as Decoder>::Item, Either<<U as Decoder>::Error, Error>>>>

Try to read underlying I/O stream and decode item.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T, U> Sink<<U as Encoder>::Item> for Framed<T, U> where
    T: AsyncRead + AsyncWrite + Unpin,
    U: Encoder + Unpin, 

type Error = Either<U::Error, Error>

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

fn poll_ready(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Self>,
    item: <U as Encoder>::Item
) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T, U> Stream for Framed<T, U> where
    T: AsyncRead + Unpin,
    U: Decoder + Unpin, 

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

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.