Struct asynchronous_codec::Framed

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

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

Example

use bytes::Bytes;
use futures::{SinkExt, TryStreamExt};
use futures::io::Cursor;
use asynchronous_codec::{BytesCodec, Framed};

let cur = Cursor::new(vec![0u8; 12]);
let mut framed = Framed::new(cur, BytesCodec {});

// Send bytes to `buf` through the `BytesCodec`
let bytes = Bytes::from("Hello world!");
framed.send(bytes).await?;

// Drop down to the underlying I/O stream.
let cur = framed.into_inner();
assert_eq!(cur.get_ref(), b"Hello world!");

Implementations

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

where T: AsyncRead + AsyncWrite, U: Decoder + Encoder,

pub fn new(inner: T, codec: U) -> Self

Creates a new Framed transport with the given codec. A codec is a type which implements Decoder and Encoder.

pub fn from_parts(_: FramedParts<T, U>) -> Self

Creates a new Framed from FramedParts.

See also Framed::into_parts.

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

Consumes the Framed, returning its parts, such that a new Framed may be constructed, possibly with a different codec.

See also Framed::from_parts.

pub fn into_inner(self) -> T

Consumes the Framed, returning its underlying I/O stream.

Note that data that has already been read or written but not yet consumed by the decoder or flushed, respectively, is dropped. To retain any such potentially buffered data, use Framed::into_parts().

pub fn codec(&self) -> &U

Returns a reference to the underlying codec wrapped by Framed.

Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.

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

Returns a mutable reference to the underlying codec wrapped by Framed.

Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.

pub fn read_buffer(&self) -> &BytesMut

Returns a reference to the read buffer.

pub fn send_high_water_mark(&self) -> usize

High-water mark for writes, in bytes

See [FramedWrite::send_high_water_mark].

pub fn set_send_high_water_mark(&mut self, hwm: usize)

Sets high-water mark for writes, in bytes

See [FramedWrite::set_send_high_water_mark].

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T, U> Deref for Framed<T, U>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, U> DerefMut for Framed<T, U>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T, U> Sink<<U as Encoder>::Item> for Framed<T, U>

where T: AsyncWrite + Unpin, U: Encoder,

type Error = <U as Encoder>::Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: U::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,

type Item = Result<<U as Decoder>::Item, <U as Decoder>::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.

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

Returns the bounds on the remaining length of the stream.

impl<'__pin, T, U> Unpin for Framed<T, U>

where __Origin<'__pin, T, U>: Unpin,