[−][src]Struct actix_codec::Framed
A unified Stream
and Sink
interface to an underlying I/O object, using
the Encoder
and Decoder
traits to encode and decode frames.
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 Encoder
/Decoder
traits to handle encoding and decoding of message frames. Note that
the incoming and outgoing frame types may be distinct.
Implementations
impl<T, U> Framed<T, U> where
T: AsyncRead + AsyncWrite,
U: Decoder,
[src]
T: AsyncRead + AsyncWrite,
U: Decoder,
pub fn new(io: T, codec: U) -> Framed<T, U>
[src]
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.
impl<T, U> Framed<T, U>
[src]
pub fn codec_ref(&self) -> &U
[src]
Returns a reference to the underlying codec.
pub fn codec_mut(&mut self) -> &mut U
[src]
Returns a mutable reference to the underlying codec.
pub fn io_ref(&self) -> &T
[src]
Returns a reference to the underlying I/O stream wrapped by
Frame
.
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 io_mut(&mut self) -> &mut T
[src]
Returns a mutable reference to the 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 io_pin(self: Pin<&mut Self>) -> Pin<&mut T>
[src]
Returns a Pin
of a mutable reference to the underlying I/O stream.
pub fn is_read_buf_empty(&self) -> bool
[src]
Check if read buffer is empty.
pub fn is_write_buf_empty(&self) -> bool
[src]
Check if write buffer is empty.
pub fn is_write_buf_full(&self) -> bool
[src]
Check if write buffer is full.
pub fn is_write_ready(&self) -> bool
[src]
Check if framed is able to write more data.
Framed
object considers ready if there is free space in write buffer.
pub fn replace_codec<U2>(self, codec: U2) -> Framed<T, U2>
[src]
Consume the Frame
, returning Frame
with different codec.
pub fn into_map_io<F, T2>(self, f: F) -> Framed<T2, U> where
F: Fn(T) -> T2,
[src]
F: Fn(T) -> T2,
Consume the Frame
, returning Frame
with different io.
pub fn into_map_codec<F, U2>(self, f: F) -> Framed<T, U2> where
F: Fn(U) -> U2,
[src]
F: Fn(U) -> U2,
Consume the Frame
, returning Frame
with different codec.
impl<T, U> Framed<T, U>
[src]
pub fn write<I>(
self: Pin<&mut Self>,
item: I
) -> Result<(), <U as Encoder<I>>::Error> where
T: AsyncWrite,
U: Encoder<I>,
[src]
self: Pin<&mut Self>,
item: I
) -> Result<(), <U as Encoder<I>>::Error> where
T: AsyncWrite,
U: Encoder<I>,
Serialize item and Write to the inner buffer
pub fn next_item(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<U as Decoder>::Item, U::Error>>> where
T: AsyncRead,
U: Decoder,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<U as Decoder>::Item, U::Error>>> where
T: AsyncRead,
U: Decoder,
Try to read underlying I/O stream and decode item.
pub fn flush<I>(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), U::Error>> where
T: AsyncWrite,
U: Encoder<I>,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), U::Error>> where
T: AsyncWrite,
U: Encoder<I>,
Flush write buffer to underlying I/O stream.
pub fn close<I>(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), U::Error>> where
T: AsyncWrite,
U: Encoder<I>,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), U::Error>> where
T: AsyncWrite,
U: Encoder<I>,
Flush write buffer and shutdown underlying I/O stream.
impl<T, U> Framed<T, U>
[src]
pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>
[src]
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.
These objects take a stream, a read buffer and a write buffer. These
fields can be obtained from an existing Framed
with the into_parts
method.
pub fn into_parts(self) -> FramedParts<T, U>
[src]
Consumes the Frame
, 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, U> PinnedDrop for Framed<T, U>
[src]
impl<T, U, I> 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>,
_: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
_: &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>>
fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<'pin, T, U> Unpin for Framed<T, U> where
__Framed<'pin, T, U>: Unpin,
[src]
__Framed<'pin, T, U>: Unpin,
impl<T, U> UnsafeUnpin for Framed<T, U>
[src]
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,
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<St> StreamExt for St where
St: Stream + ?Sized,
[src]
St: Stream + ?Sized,
fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,
[src]
Self: Stream<Item = Result<T, E>> + Unpin,
fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,
[src]
F: FnMut(Self::Item) -> T,
fn merge<U>(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,
[src]
U: Stream<Item = Self::Item>,
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,
[src]
F: FnMut(Self::Item) -> Option<T>,
fn fuse(self) -> Fuse<Self>
[src]
fn take(self, n: usize) -> Take<Self>
[src]
fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
fn skip(self, n: usize) -> Skip<Self>
[src]
fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
F: FnMut(Self::Item) -> bool,
Self: Unpin,
[src]
F: FnMut(Self::Item) -> bool,
Self: Unpin,
fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
F: FnMut(Self::Item) -> bool,
Self: Unpin,
[src]
F: FnMut(Self::Item) -> bool,
Self: Unpin,
fn chain<U>(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,
[src]
U: Stream<Item = Self::Item>,
fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,
[src]
F: FnMut(B, Self::Item) -> B,
fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,
[src]
T: FromStream<Self::Item>,
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.
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.
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,