Struct tokio_serde::Framed

pub struct Framed<Transport, Item, SinkItem, Codec> { /* private fields */ }

Adapts a transport to a value sink by serializing the values and to a stream of values by deserializing them.

It is expected that the buffers yielded by the supplied transport be framed. In other words, each yielded buffer must represent exactly one serialized value.

The provided transport will receive buffer values containing the serialized value. Each buffer contains exactly one value. This sink will be responsible for writing these buffers to an AsyncWrite using some sort of framing strategy.

The specific framing strategy is left up to the implementor. One option would be to use length_delimited provided by tokio-util.

Implementations

impl<Transport, Item, SinkItem, Codec> Framed<Transport, Item, SinkItem, Codec>

pub fn new(inner: Transport, codec: Codec) -> Self

Creates a new Framed with the given transport and codec.

pub fn get_ref(&self) -> &Transport

Returns a reference to the underlying transport wrapped by Framed.

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

pub fn get_mut(&mut self) -> &mut Transport

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

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

pub fn into_inner(self) -> Transport

Consumes the Framed, returning its underlying transport.

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

Trait Implementations

impl<Transport: Debug, Item: Debug, SinkItem: Debug, Codec: Debug> Debug for Framed<Transport, Item, SinkItem, Codec>

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

Formats the value using the given formatter.

impl<Transport, Item, SinkItem, Codec> Sink<SinkItem> for Framed<Transport, Item, SinkItem, Codec> where
    Transport: Sink<Bytes>,
    Codec: Serializer<SinkItem>,
    Codec::Error: Into<Transport::Error>, 

type Error = Transport::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: SinkItem) -> 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<Transport, Item, SinkItem, Codec> Stream for Framed<Transport, Item, SinkItem, Codec> where
    Transport: TryStream<Ok = BytesMut>,
    Transport::Error: From<Codec::Error>,
    BytesMut: From<Transport::Ok>,
    Codec: Deserializer<Item>, 

type Item = Result<Item, Transport::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, Transport, Item, SinkItem, Codec> Unpin for Framed<Transport, Item, SinkItem, Codec> where
    __Framed<'pin, Transport, Item, SinkItem, Codec>: Unpin,