Struct tokio_util::codec::FramedRead
source · pub struct FramedRead<T, D> { /* private fields */ }
Expand description
A Stream
of messages decoded from an AsyncRead
.
For examples of how to use FramedRead
with a codec, see the
examples on the codec
module.
§Cancellation safety
tokio_stream::StreamExt::next
: This method is cancel safe. The returned future only holds onto a reference to the underlying stream, so dropping it will never lose a value.
Implementations§
source§impl<T, D> FramedRead<T, D>
impl<T, D> FramedRead<T, D>
sourcepub fn new(inner: T, decoder: D) -> FramedRead<T, D>
pub fn new(inner: T, decoder: D) -> FramedRead<T, D>
Creates a new FramedRead
with the given decoder
.
sourcepub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D>
pub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D>
Creates a new FramedRead
with the given decoder
and a buffer of capacity
initial size.
source§impl<T, D> FramedRead<T, D>
impl<T, D> FramedRead<T, D>
sourcepub fn get_ref(&self) -> &T
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.
sourcepub fn get_mut(&mut self) -> &mut T
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.
sourcepub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>
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
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.
sourcepub fn into_inner(self) -> T
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.
sourcepub fn decoder_mut(&mut self) -> &mut D
pub fn decoder_mut(&mut self) -> &mut D
Returns a mutable reference to the underlying decoder.
sourcepub fn map_decoder<C, F>(self, map: F) -> FramedRead<T, C>where
F: FnOnce(D) -> C,
pub fn map_decoder<C, F>(self, map: F) -> FramedRead<T, C>where
F: FnOnce(D) -> C,
Maps the decoder D
to C
, preserving the read buffer
wrapped by Framed
.
sourcepub fn decoder_pin_mut(self: Pin<&mut Self>) -> &mut D
pub fn decoder_pin_mut(self: Pin<&mut Self>) -> &mut D
Returns a mutable reference to the underlying decoder.
sourcepub fn read_buffer(&self) -> &BytesMut
pub fn read_buffer(&self) -> &BytesMut
Returns a reference to the read buffer.
sourcepub fn read_buffer_mut(&mut self) -> &mut BytesMut
pub fn read_buffer_mut(&mut self) -> &mut BytesMut
Returns a mutable reference to the read buffer.
Trait Implementations§
source§impl<T, D> Debug for FramedRead<T, D>
impl<T, D> Debug for FramedRead<T, D>
source§impl<T, I, D> Sink<I> for FramedRead<T, D>where
T: Sink<I>,
impl<T, I, D> Sink<I> for FramedRead<T, D>where
T: Sink<I>,
source§fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<(), Self::Error>>
fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>
Sink
to receive a value. Read moresource§fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
poll_ready
which returned Poll::Ready(Ok(()))
. Read more