actix_codec

# Struct Framed

source

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

Expand description

A unified `Stream` and `Sink` interface to an underlying I/O object, using the `Encoder` and `Decoder` traits to encode and decode frames.

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 `Encoder`/`Decoder` traits to handle encoding and decoding of message frames. Note that the incoming and outgoing frame types may be distinct.

## Implementations§

source §

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

source

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

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.

source §

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

source

#### pub fn codec_ref(&self) -> &U

Returns a reference to the underlying codec.

source

#### pub fn codec_mut(&mut self) -> &mut U

Returns a mutable reference to the underlying codec.

source

#### pub fn io_ref(&self) -> &T

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.

source

#### pub fn io_mut(&mut self) -> &mut T

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

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.

source

#### pub fn io_pin(self: Pin<&mut Self>) -> Pin<&mut T>

Returns a `Pin` of a mutable reference to the underlying I/O stream.

source

#### pub fn is_read_buf_empty(&self) -> bool

Check if read buffer is empty.

source

#### pub fn is_write_buf_empty(&self) -> bool

Check if write buffer is empty.

source

#### pub fn is_write_buf_full(&self) -> bool

Check if write buffer is full.

source

#### 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.

source

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

Consume the `Frame`, returning `Frame` with different codec.

source

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

Consume the `Frame`, returning `Frame` with different io.

source

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

Consume the `Frame`, returning `Frame` with different codec.

source §

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

source

#### pub fn write<I>( self: Pin<&mut Self>, item: I, ) -> Result<(), <U as Encoder<I>>::Error>
where T: AsyncWrite, U: Encoder<I>,

Serialize item and write to the inner buffer

source

#### pub fn next_item( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<U as Decoder>::Item, U::Error>>>
where T: AsyncRead, U: Decoder,

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

source

#### pub fn flush<I>( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), U::Error>>
where T: AsyncWrite, U: Encoder<I>,

Flush write buffer to underlying I/O stream.

source

#### pub fn close<I>( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), U::Error>>
where T: AsyncWrite, U: Encoder<I>,

Flush write buffer and shutdown underlying I/O stream.

source §

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

source

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

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.

These objects take a stream, a read buffer and a write buffer. These fields can be obtained from an existing `Framed` with the `into_parts` method.

source

#### 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.

## Trait Implementations§

source §

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

source §

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

Formats the value using the given formatter. Read more
source §

### impl<T, U, I> Sink<I> for Framed<T, U>
where T: AsyncWrite, U: Encoder<I>, U::Error: From<Error>,

source §

#### type Error = <U as Encoder<I>>::Error

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

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

Attempts to prepare the `Sink` to receive a value. Read more
source §

#### fn start_send(self: Pin<&mut Self>, item: I) -> 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(()))`. Read more
source §

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

Flush any remaining output from this sink. Read more
source §

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

Flush any remaining output and close this sink, if necessary. Read more
source §

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

source §

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

Values yielded by the stream.
source §

#### 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. Read more
§

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

Returns the bounds on the remaining length of the stream. Read more
source §

### impl<'__pin, T, U> Unpin for Framed<T, U>
where __Origin<'__pin, T, U>: Unpin,

## Auto Trait Implementations§

§

### impl<T, U> Freeze for Framed<T, U>
where T: Freeze, U: Freeze,

§

### impl<T, U> RefUnwindSafe for Framed<T, U>
where T: RefUnwindSafe, U: RefUnwindSafe,

§

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

## Blanket Implementations§

source §

### impl<T> Any for T
where T: 'static + ?Sized,

source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source §

### impl<T> Borrow<T> for T
where T: ?Sized,

source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source §

### impl<T> From<T> for T

source §

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source §

### impl<T, U> Into<U> for T
where U: From<T>,

source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

source §

#### type Error = Infallible

The type returned in the event of a conversion error.
source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source §

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

§

#### type Ok = T

The type of successful values yielded by this future
§

#### type Error = E

The type of failures yielded by this future
§

#### fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this `TryStream` as if it were a `Stream`. Read more
§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more