Struct tokio_codec::FramedRead

pub struct FramedRead<T, D> { /* fields omitted */ }

A Stream of messages decoded from an AsyncRead.

Methods

impl<T, D> FramedRead<T, D> where
    T: AsyncRead,
    D: Decoder, 

pub fn new(inner: T, decoder: D) -> FramedRead<T, D>

Creates a new FramedRead with the given decoder.

impl<T, D> FramedRead<T, D>

pub fn get_ref(&self) -> &T

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

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

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 into_inner(self) -> T

Consumes the FramedRead, returning its 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.

pub fn decoder(&self) -> &D

Returns a reference to the underlying decoder.

pub fn decoder_mut(&mut self) -> &mut D

Returns a mutable reference to the underlying decoder.

Trait Implementations

impl<T, D> Debug for FramedRead<T, D> where
    T: Debug,
    D: Debug, 

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

Formats the value using the given formatter.

impl<T, D> Stream for FramedRead<T, D> where
    T: AsyncRead + Unpin,
    D: Decoder + Unpin, 

type Item = Result<D::Item, D::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.

impl<T, I, D> Sink<I> for FramedRead<T, D> where
    T: Sink<I> + Unpin,
    D: Unpin, 

type Error = T::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: 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(())).

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.