[][src]Struct ntex::codec::Framed

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

A unified Stream and Sink 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.

Methods

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

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

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode 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.

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

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

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode 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.

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

Returns a reference to the underlying codec.

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

Returns a mutable reference to the underlying codec.

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

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

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]

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

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[src]

Get read buffer.

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

Get write buffer.

pub fn is_write_buf_empty(&self) -> bool[src]

Check if write buffer is empty.

pub fn is_write_buf_full(&self) -> bool[src]

Check if write buffer is full.

pub fn is_closed(&self) -> bool[src]

Check if framed object is closed

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

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, 
[src]

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, 
[src]

Consume the Frame, returning Frame with different codec.

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

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
[src]

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

Serialize item and Write to the inner buffer

pub fn is_write_ready(&self) -> bool[src]

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<(), <U as Encoder>::Error>>
[src]

Flush write buffer to underlying I/O stream.

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

pub fn close(&mut self, cx: &mut Context) -> Poll<Result<(), Error>>[src]

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
[src]

pub fn next_item(
    &mut self,
    cx: &mut Context
) -> Poll<Option<Result<<U as Decoder>::Item, <U as Decoder>::Error>>>
[src]

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
[src]

impl<T, U> Sink<<U as Encoder>::Item> for Framed<T, U> where
    T: AsyncRead + AsyncWrite + Unpin,
    U: Encoder + Unpin,
    <U as Encoder>::Error: From<Error>, 
[src]

type Error = <U as Encoder>::Error

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

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

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

Values yielded by the stream.

Auto Trait Implementations

impl<T, U> !RefUnwindSafe for Framed<T, U>

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

impl<T, U> !UnwindSafe for Framed<T, U>

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<T> Same<T> for T

type Output = T

Should always be Self

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized
[src]

impl<T> StreamExt for T where
    T: Stream + ?Sized
[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

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,