Struct ntex_codec::Framed [−][src]
A unified interface to an underlying I/O object, using
the Encoder
and Decoder
traits to encode and decode frames.
Framed
is heavily optimized for streaming io.
Implementations
impl<T, U> Framed<T, U> where
T: AsyncRead + AsyncWrite,
U: Decoder + Encoder,
[src]
T: AsyncRead + AsyncWrite,
U: Decoder + Encoder,
pub fn new(io: T, codec: U) -> Framed<T, U>
[src]
Provides an interface for reading and writing to
Io
object, using Decode
and Encode
traits of codec.
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.
impl<T, U> Framed<T, U>
[src]
pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>
[src]
Construct Framed
object parts
.
pub fn get_codec(&self) -> &U
[src]
Returns a reference to the underlying codec.
pub fn get_codec_mut(&mut self) -> &mut U
[src]
Returns a mutable reference to the underlying codec.
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 read_buf(&mut self) -> &mut BytesMut
[src]
Get read buffer.
pub fn write_buf(&mut self) -> &mut BytesMut
[src]
Get write buffer.
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_closed(&self) -> bool
[src]
Check if framed object is closed
pub fn into_framed<U2>(self, codec: U2) -> Framed<T, U2>
[src]
Consume the Frame
, returning Frame
with different codec.
pub fn 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 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.
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.
impl<T, U> Framed<T, U> where
T: AsyncWrite + Unpin,
U: Encoder,
[src]
T: AsyncWrite + Unpin,
U: Encoder,
pub fn write(
&mut self,
item: <U as Encoder>::Item
) -> Result<(), <U as Encoder>::Error>
[src]
&mut self,
item: <U as Encoder>::Item
) -> Result<(), <U as Encoder>::Error>
Serialize item and Write to the inner buffer
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 flush(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
[src]
Flush write buffer to underlying I/O stream.
impl<T, U> Framed<T, U> where
T: AsyncRead + AsyncWrite + Unpin,
[src]
T: AsyncRead + AsyncWrite + Unpin,
pub fn close(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Error>>
[src]
Flush write buffer and shutdown underlying I/O stream.
Close method shutdown write side of a io object and then reads until disconnect or error, high level code must use timeout for close operation.
impl<T, U> Framed<T, U> where
T: AsyncRead + Unpin,
U: Decoder,
[src]
T: AsyncRead + Unpin,
U: Decoder,
pub fn next_item(
&mut self,
cx: &mut Context<'_>
) -> Poll<Option<Result<<U as Decoder>::Item, Either<<U as Decoder>::Error, Error>>>>
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Option<Result<<U as Decoder>::Item, Either<<U as Decoder>::Error, Error>>>>
Try to read underlying I/O stream and decode item.
Trait Implementations
impl<T, U> Debug for Framed<T, U> where
T: Debug,
U: Debug,
[src]
T: Debug,
U: Debug,
impl<T, U> Sink<<U as Encoder>::Item> for Framed<T, U> where
T: AsyncRead + AsyncWrite + Unpin,
U: Encoder + Unpin,
[src]
T: AsyncRead + AsyncWrite + Unpin,
U: Encoder + Unpin,
type Error = Either<U::Error, 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: <U as Encoder>::Item
) -> Result<(), Self::Error>
[src]
self: Pin<&mut Self>,
item: <U as Encoder>::Item
) -> Result<(), Self::Error>
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 + Unpin,
U: Decoder + Unpin,
[src]
T: AsyncRead + Unpin,
U: Decoder + Unpin,
Auto Trait Implementations
impl<T, U> !RefUnwindSafe for Framed<T, U>
[src]
impl<T, U> Send for Framed<T, U> where
T: Send,
U: Send,
[src]
T: Send,
U: Send,
impl<T, U> Sync for Framed<T, U> where
T: Sync,
U: Sync,
[src]
T: Sync,
U: Sync,
impl<T, U> Unpin for Framed<T, U> where
T: Unpin,
U: Unpin,
[src]
T: Unpin,
U: Unpin,
impl<T, U> !UnwindSafe for Framed<T, U>
[src]
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<St> StreamExt for St where
St: Stream + ?Sized,
[src]
St: Stream + ?Sized,
pub fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,
[src]
Self: Unpin,
pub 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,
pub fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,
[src]
F: FnMut(Self::Item) -> T,
pub fn merge<U>(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,
[src]
U: Stream<Item = Self::Item>,
pub fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
pub 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>,
pub fn fuse(self) -> Fuse<Self>
[src]
pub fn take(self, n: usize) -> Take<Self>
[src]
pub fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
pub fn skip(self, n: usize) -> Skip<Self>
[src]
pub fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,
[src]
F: FnMut(&Self::Item) -> bool,
pub fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,
[src]
Self: Unpin,
F: FnMut(Self::Item) -> bool,
pub fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,
[src]
Self: Unpin,
F: FnMut(Self::Item) -> bool,
pub fn chain<U>(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,
[src]
U: Stream<Item = Self::Item>,
pub 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,
pub fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,
[src]
T: FromStream<Self::Item>,
pub fn timeout(self, duration: Duration) -> Timeout<Self>
[src]
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,