Struct tokio_util::codec::FramedWrite

source · [−]

pub struct FramedWrite<T, E> { /* private fields */ }

Expand description

A Sink of frames encoded to an AsyncWrite.

Implementations

source

impl<T, E> FramedWrite<T, E> where
T: AsyncWrite,

source

pub fn new(inner: T, encoder: E) -> FramedWrite<T, E>

Creates a new FramedWrite with the given encoder.

source

impl<T, E> FramedWrite<T, E>

source

pub fn get_ref(&self) -> &T

Returns a reference to the underlying I/O stream wrapped by FramedWrite.

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.

source

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying I/O stream wrapped by FramedWrite.

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.

source

pub fn into_inner(self) -> T

Consumes the FramedWrite, 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.

source

pub fn encoder(&self) -> &E

Returns a reference to the underlying decoder.

source

pub fn encoder_mut(&mut self) -> &mut E

Returns a mutable reference to the underlying decoder.

Trait Implementations

source

impl<T, U> Debug for FramedWrite<T, U> where
T: Debug,
U: Debug,

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl<T, I, E> Sink for FramedWrite<T, E> where
 T: AsyncWrite,
 E: Encoder,
 E::Error: From<Error>,

type Error = E::Error

The type of value produced by the sink when an error occurs.

source

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more

source

fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>

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

source

fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more

source

fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more

source

impl<T, D> Stream for FramedWrite<T, D> where
T: Stream,

type Item = T::Item

Values yielded by the stream.

source

fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

source

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

source

impl<'pin, T, E> Unpin for FramedWrite<T, E> where
Origin<'__pin, T, E>: Unpin,

Auto Trait Implementations

impl<T, E> RefUnwindSafe for FramedWrite<T, E> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, E> Send for FramedWrite<T, E> where
E: Send,
T: Send,

impl<T, E> Sync for FramedWrite<T, E> where
E: Sync,
T: Sync,

impl<T, E> UnwindSafe for FramedWrite<T, E> where
E: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<St> StreamExt for St where
St: Stream + ?Sized,

source

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

Consumes and returns the next value in the stream or None if the stream is finished. Read more

source

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

source

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

source

fn merge(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by interleaving the output of both as it is produced. Read more

source

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

Filters the values produced by this stream according to the provided predicate. Read more

source

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

source

fn fuse(self) -> Fuse<Self>

Creates a stream which ends after the first None. Read more

source

fn take(self, n: usize) -> Take<Self>

Creates a new stream of at most n items of the underlying stream. Read more

source

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Take elements from this stream while the provided predicate resolves to true. Read more

source

fn skip(self, n: usize) -> Skip<Self>

Creates a new stream that will skip the n first items of the underlying stream. Read more

source

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

source

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if every element of the stream matches a predicate. Read more

source

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if any element of the stream matches a predicate. Read more

source

fn chain(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

source

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,

A combinator that applies a function to every element in a stream producing a single, final value. Read more

source

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

Drain stream pushing all emitted values into a collection. Read more

source

fn timeout(self, duration: Duration) -> Timeout<Self>

Applies a per-item timeout to the passed stream. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more

Struct tokio_util::codec::FramedWrite

Implementations

impl<T, E> FramedWrite<T, E> where T: AsyncWrite,

pub fn new(inner: T, encoder: E) -> FramedWrite<T, E>

impl<T, E> FramedWrite<T, E>

pub fn get_ref(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn into_inner(self) -> T

pub fn encoder(&self) -> &E

pub fn encoder_mut(&mut self) -> &mut E

Trait Implementations

impl<T, U> Debug for FramedWrite<T, U> where T: Debug, U: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<T, I, E> Sink<I> for FramedWrite<T, E> where T: AsyncWrite, E: Encoder<I>, E::Error: From<Error>,

type Error = E::Error

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>

fn poll_flush( 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>>

impl<T, D> Stream for FramedWrite<T, D> where T: Stream,

type Item = T::Item

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>

fn size_hint(&self) -> (usize, Option<usize>)

impl<'__pin, T, E> Unpin for FramedWrite<T, E> where __Origin<'__pin, T, E>: Unpin,

Auto Trait Implementations

impl<T, E> RefUnwindSafe for FramedWrite<T, E> where E: RefUnwindSafe, T: RefUnwindSafe,

impl<T, E> Send for FramedWrite<T, E> where E: Send, T: Send,

impl<T, E> Sync for FramedWrite<T, E> where E: Sync, T: Sync,

impl<T, E> UnwindSafe for FramedWrite<T, E> where E: UnwindSafe, T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<St> StreamExt for St where St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<T>,

fn fuse(self) -> Fuse<Self>

fn take(self, n: usize) -> Take<Self>

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn skip(self, n: usize) -> Skip<Self>

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where 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,

fn collect<T>(self) -> Collect<Self, T> where T: FromStream<Self::Item>,

fn timeout(self, duration: Duration) -> Timeout<Self>

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<S, T, E> TryStream for S where S: Stream<Item = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

pub fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

impl<T, E> FramedWrite<T, E> where
T: AsyncWrite,

impl<T, U> Debug for FramedWrite<T, U> where
T: Debug,
U: Debug,

impl<T, I, E> Sink<I> for FramedWrite<T, E> where
T: AsyncWrite,
E: Encoder<I>,
E::Error: From<Error>,

fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_flush(
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>>

impl<T, D> Stream for FramedWrite<T, D> where
T: Stream,

fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

impl<'pin, T, E> Unpin for FramedWrite<T, E> where
Origin<'__pin, T, E>: Unpin,

impl<T, E> RefUnwindSafe for FramedWrite<T, E> where
E: RefUnwindSafe,
T: RefUnwindSafe,

impl<T, E> Send for FramedWrite<T, E> where
E: Send,
T: Send,

impl<T, E> Sync for FramedWrite<T, E> where
E: Sync,
T: Sync,

impl<T, E> UnwindSafe for FramedWrite<T, E> where
E: UnwindSafe,
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<St> StreamExt for St where
St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where
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,

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>