Struct tokio_util::codec::Framed [−][src]
pub struct Framed<T, U> { /* fields omitted */ }
A unified Stream
and Sink
interface to an underlying I/O object, using
the Encoder
and Decoder
traits to encode and decode frames.
You can create a Framed
instance by using the Decoder::framed
adapter, or
by using the new
function seen below.
Implementations
impl<T, U> Framed<T, U> where
T: AsyncRead + AsyncWrite,
[src]
T: AsyncRead + AsyncWrite,
pub fn new(inner: T, codec: U) -> Framed<T, U>
[src]
Provides a Stream
and Sink
interface for reading and writing to this
I/O object, using Decoder
and Encoder
to read and write the raw data.
Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called “frames”. This method layers framing on top of an I/O object, by using the codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.
This function returns a single object that is both Stream
and
Sink
; grouping this into a single object is often useful for layering
things like gzip or TLS, which require both read and write access to the
underlying object.
If you want to work more directly with the streams and sink, consider
calling split
on the Framed
returned by this method, which will
break them into separate objects, allowing them to interact more easily.
Note that, for some byte sources, the stream can be resumed after an EOF
by reading from it, even after it has returned None
. Repeated attempts
to do so, without new data available, continue to return None
without
creating more (closing) frames.
pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U>
[src]
Provides a Stream
and Sink
interface for reading and writing to this
I/O object, using Decoder
and Encoder
to read and write the raw data,
with a specific read buffer initial capacity.
Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called “frames”. This method layers framing on top of an I/O object, by using the codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.
This function returns a single object that is both Stream
and
Sink
; grouping this into a single object is often useful for layering
things like gzip or TLS, which require both read and write access to the
underlying object.
If you want to work more directly with the streams and sink, consider
calling split
on the Framed
returned by this method, which will
break them into separate objects, allowing them to interact more easily.
impl<T, U> Framed<T, U>
[src]
pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>
[src]
Provides a Stream
and Sink
interface for reading and writing to this
I/O object, using Decoder
and Encoder
to read and write the raw data.
Raw I/O objects work with byte sequences, but higher-level code usually
wants to batch these into meaningful chunks, called “frames”. This
method layers framing on top of an I/O object, by using the Codec
traits to handle encoding and decoding of messages frames. Note that
the incoming and outgoing frame types may be distinct.
This function returns a single object that is both Stream
and
Sink
; grouping this into a single object is often useful for layering
things like gzip or TLS, which require both read and write access to the
underlying object.
This objects takes a stream and a readbuffer and a writebuffer. These field
can be obtained from an existing Framed
with the into_parts
method.
If you want to work more directly with the streams and sink, consider
calling split
on the Framed
returned by this method, which will
break them into separate objects, allowing them to interact more easily.
pub fn get_ref(&self) -> &T
[src]
Returns a reference to the underlying I/O stream wrapped by
Framed
.
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]
Returns a mutable reference to the underlying I/O stream wrapped by
Framed
.
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]
Returns a pinned mutable reference to the underlying I/O stream wrapped by
Framed
.
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 codec(&self) -> &U
[src]
Returns a reference to the underlying codec wrapped by
Framed
.
Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.
pub fn codec_mut(&mut self) -> &mut U
[src]
Returns a mutable reference to the underlying codec wrapped by
Framed
.
Note that care should be taken to not tamper with the underlying codec as it may corrupt the stream of frames otherwise being worked with.
pub fn read_buffer(&self) -> &BytesMut
[src]
Returns a reference to the read buffer.
pub fn read_buffer_mut(&mut self) -> &mut BytesMut
[src]
Returns a mutable reference to the read buffer.
pub fn write_buffer(&self) -> &BytesMut
[src]
Returns a reference to the write buffer.
pub fn write_buffer_mut(&mut self) -> &mut BytesMut
[src]
Returns a mutable reference to the write buffer.
pub fn into_inner(self) -> T
[src]
Consumes the Framed
, 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 into_parts(self) -> FramedParts<T, U>
[src]
Consumes the Framed
, returning its underlying I/O stream, the buffer
with unprocessed data, and the codec.
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.
Trait Implementations
impl<T, U> Debug for Framed<T, U> where
T: Debug,
U: Debug,
[src]
T: Debug,
U: Debug,
impl<T, I, U> Sink<I> for Framed<T, U> where
T: AsyncWrite,
U: Encoder<I>,
U::Error: From<Error>,
[src]
T: AsyncWrite,
U: Encoder<I>,
U::Error: From<Error>,
type Error = U::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>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
[src]
fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
impl<T, U> Stream for Framed<T, U> where
T: AsyncRead,
U: Decoder,
[src]
T: AsyncRead,
U: Decoder,
type Item = Result<U::Item, U::Error>
Values yielded by the stream.
fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
pub fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<'__pin, T, U> Unpin for Framed<T, U> where
__Origin<'__pin, T, U>: Unpin,
[src]
__Origin<'__pin, T, U>: Unpin,
Auto Trait Implementations
impl<T, U> RefUnwindSafe for Framed<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
impl<T, U> Send for Framed<T, U> where
T: Send,
U: Send,
T: Send,
U: Send,
impl<T, U> Sync for Framed<T, U> where
T: Sync,
U: Sync,
T: Sync,
U: Sync,
impl<T, U> UnwindSafe for Framed<T, U> where
T: UnwindSafe,
U: UnwindSafe,
T: UnwindSafe,
U: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,
[src]
S: Stream<Item = Result<T, E>> + ?Sized,