Struct tokio_util::codec::FramedRead [−][src]
pub struct FramedRead<T, D> { /* fields omitted */ }
codec
only.Implementations
impl<T, D> FramedRead<T, D> where
T: AsyncRead,
D: Decoder,
[src]
impl<T, D> FramedRead<T, D> where
T: AsyncRead,
D: Decoder,
[src]pub fn new(inner: T, decoder: D) -> FramedRead<T, D>
[src]
pub fn new(inner: T, decoder: D) -> FramedRead<T, D>
[src]Creates a new FramedRead
with the given decoder
.
pub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D>
[src]
pub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D>
[src]Creates a new FramedRead
with the given decoder
and a buffer of capacity
initial size.
impl<T, D> FramedRead<T, D>
[src]
impl<T, D> FramedRead<T, D>
[src]pub fn get_ref(&self) -> &T
[src]
pub fn get_ref(&self) -> &T
[src]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
[src]
pub fn get_mut(&mut self) -> &mut T
[src]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 get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>
[src]
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>
[src]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.
pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
[src]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_mut(&mut self) -> &mut D
[src]
pub fn decoder_mut(&mut self) -> &mut D
[src]Returns a mutable reference to the underlying decoder.
pub fn read_buffer(&self) -> &BytesMut
[src]
pub fn read_buffer(&self) -> &BytesMut
[src]Returns a reference to the read buffer.
pub fn read_buffer_mut(&mut self) -> &mut BytesMut
[src]
pub fn read_buffer_mut(&mut self) -> &mut BytesMut
[src]Returns a mutable reference to the read buffer.
Trait Implementations
impl<T, D> Debug for FramedRead<T, D> where
T: Debug,
D: Debug,
[src]
impl<T, D> Debug for FramedRead<T, D> where
T: Debug,
D: Debug,
[src]impl<T, I, D> Sink<I> for FramedRead<T, D> where
T: Sink<I>,
[src]
impl<T, I, D> Sink<I> for FramedRead<T, D> where
T: Sink<I>,
[src]fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]Attempts to prepare the Sink
to receive a value. Read more
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
[src]
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
[src]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(()))
. Read more
impl<T, D> Stream for FramedRead<T, D> where
T: AsyncRead,
D: Decoder,
[src]
impl<T, D> Stream for FramedRead<T, D> where
T: AsyncRead,
D: Decoder,
[src]impl<'__pin, T, D> Unpin for FramedRead<T, D> where
__Origin<'__pin, T, D>: Unpin,
[src]
__Origin<'__pin, T, D>: Unpin,
Auto Trait Implementations
impl<T, D> RefUnwindSafe for FramedRead<T, D> where
D: RefUnwindSafe,
T: RefUnwindSafe,
D: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, D> Send for FramedRead<T, D> where
D: Send,
T: Send,
D: Send,
T: Send,
impl<T, D> Sync for FramedRead<T, D> where
D: Sync,
T: Sync,
D: Sync,
T: Sync,
impl<T, D> UnwindSafe for FramedRead<T, D> where
D: UnwindSafe,
T: UnwindSafe,
D: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more