Struct Framed

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

Implementations

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

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

pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U>

pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>

pub fn get_ref(&self) -> &T

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

pub fn codec(&self) -> &U

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

pub fn read_buffer(&self) -> &BytesMut

pub fn read_buffer_mut(&mut self) -> &mut BytesMut

pub fn into_inner(self) -> T

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

Trait Implementations

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

where T: Debug, U: Debug,

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

Formats the value using the given formatter.

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

where T: AsyncWrite, U: Encoder,

type Error = 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, U: Decoder,

type Item = Result<<U as Decoder>::Item, Error<<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 PinnedFieldsOf<__Origin<'__pin, T, U>>: Unpin,