Struct tokio_util::codec::framed_write::FramedWrite

pub struct FramedWrite<T, E> {
    inner: FramedImpl<T, E, WriteFrame>,
}

A Sink of frames encoded to an AsyncWrite.

For examples of how to use FramedWrite with a codec, see the examples on the codec module.

Cancellation safety

• futures_util::sink::SinkExt::send: if send is used as the event in a tokio::select! statement and some other branch completes first, then it is guaranteed that the message was not sent, but the message itself is lost.

Fields

inner: FramedImpl<T, E, WriteFrame>

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 map_encoder<C, F>(self, map: F) -> FramedWrite<T, C>

where F: FnOnce(E) -> C,

Maps the encoder E to C, preserving the write buffer wrapped by Framed.

pub fn encoder_pin_mut(self: Pin<&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.

pub fn backpressure_boundary(&self) -> usize

Returns backpressure boundary

pub fn set_backpressure_boundary(&mut self, boundary: usize)

Updates backpressure boundary

Trait Implementations

impl<T, U> Debug for FramedWrite<T, U>

where T: Debug, U: Debug,

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>,

type Error = <E as Encoder<I>>::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,

type Item = <T as Stream>::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.

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 PinnedFieldsOf<__Origin<'__pin, T, E>>: Unpin,