Struct tokio_util::codec::FramedWrite

pub struct FramedWrite<T, E> { /* fields omitted */ }

[−] Expand description

A Sink of frames encoded to an AsyncWrite.

Implementations

impl<T, E> FramedWrite<T, E> where
    T: AsyncWrite, [−]

pub fn new(inner: T, encoder: E) -> FramedWrite<T, E>[−]

Creates a new FramedWrite with the given encoder.

impl<T, E> FramedWrite<T, E>[−]

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

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

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

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_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>[−]

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

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 FramedWrite, 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 encoder(&self) -> &E[−]

Returns a reference to the underlying encoder.

pub fn encoder_mut(&mut self) -> &mut E[−]

Returns a mutable reference to the underlying encoder.

pub fn write_buffer(&self) -> &BytesMut[−]

Returns a reference to the write buffer.

pub fn write_buffer_mut(&mut self) -> &mut BytesMut[−]

Returns a mutable reference to the write buffer.

Trait Implementations

impl<T, U> Debug for FramedWrite<T, U> where
    T: Debug,
    U: Debug, [+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T, I, E> Sink<I> for FramedWrite<T, E> where
    T: AsyncWrite,
    E: Encoder<I>,
    E::Error: From<Error>, [+]

[+] Show hidden undocumented items

type Error = E::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.

impl<T, D> Stream for FramedWrite<T, D> where
    T: Stream, [+]

[+] Show hidden undocumented items

type Item = T::Item

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.

pub fn size_hint(&self) -> (usize, Option<usize>)[−]

Returns the bounds on the remaining length of the stream.

impl<'__pin, T, E> Unpin for FramedWrite<T, E> where
    __Origin<'__pin, T, E>: Unpin,