Struct tokio_util::codec::Framed

source · [−]

pub struct Framed<T, U> { /* private fields */ }

Available on crate feature codec only.

Expand description

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

source

impl<T, U> Framed<T, U>where
T: AsyncRead + AsyncWrite,

source

pub fn new(inner: T, codec: U) -> Framed<T, U>

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.

source

pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U>

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.

source

impl<T, U> Framed<T, U>

source

pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>

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.

source

pub fn get_ref(&self) -> &T

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.

source

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

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.

source

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

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.

source

pub fn codec(&self) -> &U

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.

source

pub fn codec_mut(&mut self) -> &mut U

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.

source

pub fn map_codec<C, F>(self, map: F) -> Framed<T, C>where
F: FnOnce(U) -> C,

Maps the codec U to C, preserving the read and write buffers 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.

source

pub fn codec_pin_mut(self: Pin<&mut Self>) -> &mut U

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.

source

pub fn read_buffer(&self) -> &BytesMut

Returns a reference to the read buffer.

source

pub fn read_buffer_mut(&mut self) -> &mut BytesMut

Returns a mutable reference to the read buffer.

source

pub fn write_buffer(&self) -> &BytesMut

Returns a reference to the write buffer.

source

pub fn write_buffer_mut(&mut self) -> &mut BytesMut

Returns a mutable reference to the write buffer.

source

pub fn into_inner(self) -> T

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.

source

pub fn into_parts(self) -> FramedParts<T, U>

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

source

impl<T, U> Debug for Framed<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, U> Sink for Framed<T, U>where
 T: AsyncWrite,
 U: Encoder,
 U::Error: From<Error>,

type Error = >::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, U> Stream for Framed<T, U>where
T: AsyncRead,
U: Decoder,

type Item = Result<::Item, ::Error>

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, U> Unpin for Framed<T, U>where
Origin<'__pin, T, U>: Unpin,

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Framed<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,

impl<T, U> Send for Framed<T, U>where
T: Send,
U: Send,

impl<T, U> Sync for Framed<T, U>where
T: Sync,
U: Sync,

impl<T, U> UnwindSafe for Framed<T, U>where
T: UnwindSafe,
U: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

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<T, Item> SinkExt<Item> for Twhere
T: Sink<Item> + ?Sized,

source

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,

Composes a function in front of the sink. Read more

source

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,

Composes a function in front of the sink. Read more

source

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where
F: FnOnce(Self::Error) -> E,

Transforms the error returned by the sink.

source

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

source

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

Adds a fixed-size buffer to the current sink. Read more

source

fn close(&mut self) -> Close<'_, Self, Item>where
Self: Unpin,

Close the sink.

source

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

source

fn flush(&mut self) -> Flush<'_, Self, Item>where
Self: Unpin,

Flush the sink, processing all pending items. Read more

source

fn send(&mut self, item: Item) -> Send<'_, Self, Item>where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

source

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

source

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

source

fn left_sink<Si2>(self) -> Either<Self, Si2>where
Si2: Sink<Item, Error = Self::Error>,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

source

fn right_sink<Si1>(self) -> Either<Si1, Self>where
Si1: Sink<Item, Error = Self::Error>,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

source

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

source

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,

A convenience method for calling Sink::start_send on Unpin sink types. Read more

source

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

source

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_close on Unpin sink types. Read more

source

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

source

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

Creates a future that resolves to the next item in the stream. Read more

source

fn into_future(self) -> StreamFuture<Self>where
Self: Unpin,

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. 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 enumerate(self) -> Enumerate<Self>

Creates a stream which gives the current iteration count as well as the next value. Read more

source

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

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

source

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

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

source

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future,

Computes from this stream’s items new items of a different type using an asynchronous closure. Read more

source

fn collect<C>(self) -> Collect<Self, C>where
C: Default + Extend<Self::Item>,

Transforms a stream into a collection, returning a future representing the result of that computation. Read more

source

fn unzip<A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB>where
 FromA: Default + Extend<A>,
 FromB: Default + Extend,
 Self: Stream<Item = (A, B)>,

Converts a stream of pairs into a future, which resolves to pair of containers. Read more

source

fn concat(self) -> Concat<Self>where
 Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
 Self::Item: IntoIterator,
 Self::Item: Default,

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

source

fn count(self) -> Count<Self>

Drives the stream to completion, counting the number of items. Read more

source

fn cycle(self) -> Cycle<Self>where
Self: Clone,

Repeats a stream endlessly. Read more

source

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F>where
F: FnMut(T, Self::Item) -> Fut,
Fut: Future<Output = T>,

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

source

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

Execute predicate over asynchronous stream, and return true if any element in stream satisfied a predicate. Read more

source

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

Execute predicate over asynchronous stream, and return true if all element in stream satisfied a predicate. Read more

source

fn flatten(self) -> Flatten<Self>where
Self::Item: Stream,

Flattens a stream of streams into just one continuous stream. Read more

source

fn flatten_unordered(
 self,
 limit: impl Into<Option<usize>>
) -> FlattenUnordered<Self>where
 Self::Item: Stream,
 Self::Item: Unpin,

Flattens a stream of streams into just one continuous stream. Polls inner streams concurrently. Read more

source

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
F: FnMut(Self::Item) -> U,
U: Stream,

Maps a stream like StreamExt::map but flattens nested Streams. Read more

source

fn flat_map_unordered<U, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> FlatMapUnordered<Self, U, F>where
 U: Stream + Unpin,
 F: FnMut(Self::Item) -> U,

Maps a stream like StreamExt::map but flattens nested Streams and polls them concurrently, yielding items in any order, as they made available. Read more

source

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option>,

Combinator similar to StreamExt::fold that holds internal state and produces a new stream. Read more

source

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

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

source

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

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

source

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where
Fut: Future,

Take elements from this stream until the provided future resolves. Read more

source

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

source

fn for_each_concurrent<Fut, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> ForEachConcurrent<Self, Fut, F>where
 F: FnMut(Self::Item) -> Fut,
 Fut: Future<Output = ()>,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. 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 skip(self, n: usize) -> Skip<Self>

Creates a new stream which skips n items of the underlying stream. Read more

source

fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used to turn any Stream into a FusedStream. Read more

source

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it. Read more

source

fn catch_unwind(self) -> CatchUnwind<Self>where
Self: UnwindSafe,

Catches unwinding panics while polling the stream. Read more

source

fn boxed<'a>(
self
) -> Pin<Box<dyn Stream<Item = Self::Item> + Send + 'a, Global>>where
Self: 'a + Send,

Wrap the stream in a Box, pinning it. Read more

source

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>>where
Self: 'a,

Wrap the stream in a Box, pinning it. Read more

source

fn buffered(self, n: usize) -> Buffered<Self>where
Self::Item: Future,

An adaptor for creating a buffered list of pending futures. Read more

source

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where
Self::Item: Future,

An adaptor for creating a buffered list of pending futures (unordered). Read more

source

fn zip<St>(self, other: St) -> Zip<Self, St>where
St: Stream,

An adapter for zipping two streams together. Read more

source

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

Adapter for chaining two streams. Read more

source

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method. Read more

source

fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector. Read more

source

fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>

An adaptor for chunking up ready items of the stream inside a vector. Read more

source

fn forward<S>(self, sink: S) -> Forward<Self, S>where
S: Sink<Self::Ok, Error = Self::Error>,
Self: TryStream,

Available on crate feature sink only.

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

source

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where
Self: Sink<Item>,

Available on crate feature sink only.

Splits this Stream + Sink object into separate Sink and Stream objects. Read more

source

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),

Do something with each item of this stream, afterwards passing it on. Read more

source

fn left_stream(self) -> Either<Self, B>where
B: Stream<Item = Self::Item>,

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

source

fn right_stream(self) -> Either<B, Self>where
B: Stream<Item = Self::Item>,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

source

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where
Self: Unpin,

A convenience method for calling Stream::poll_next on Unpin stream types. Read more

source

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>where
Self: Unpin + FusedStream,

Returns a Future that resolves when the next item in this stream is ready. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<S, T, E> TryStream for Swhere
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

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

source

impl<S> TryStreamExt for Swhere
S: TryStream + ?Sized,

source

fn err_into<E>(self) -> ErrInto<Self, E>where
Self::Error: Into<E>,

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

source

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnMut(Self::Ok) -> T,

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

source

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where
F: FnMut(Self::Error) -> E,

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

source

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

source

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where
F: FnMut(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

source

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where
F: FnMut(&Self::Ok),

Do something with the success value of this stream, afterwards passing it on. Read more

source

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnMut(&Self::Error),

Do something with the error value of this stream, afterwards passing it on. Read more

source

fn into_stream(self) -> IntoStream<Self>

Wraps a TryStream into a type that implements Stream Read more

source

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

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

source

fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F>where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = Self::Error>,

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

source

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

source

fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F>where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,

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

source

fn try_for_each_concurrent<Fut, F>(
 self,
 limit: impl Into<Option<usize>>,
 f: F
) -> TryForEachConcurrent<Self, Fut, F>where
 F: FnMut(Self::Ok) -> Fut,
 Fut: Future<Output = Result<(), Self::Error>>,

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

source

fn try_collect<C>(self) -> TryCollect<Self, C>where
C: Default + Extend<Self::Ok>,

Attempt to transform a stream into a collection, returning a future representing the result of that computation. Read more

source

fn try_chunks(self, capacity: usize) -> TryChunks<Self>

An adaptor for chunking up successful items of the stream inside a vector. Read more

source

fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F>where
Fut: Future<Output = bool>,
F: FnMut(&Self::Ok) -> Fut,

Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more

source

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F>where
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
F: FnMut(Self::Ok) -> Fut,

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

source

fn try_flatten(self) -> TryFlatten<Self>where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,

Flattens a stream of streams into just one continuous stream. Read more

source

fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F>where
F: FnMut(T, Self::Ok) -> Fut,
Fut: TryFuture<Ok = T, Error = Self::Error>,

Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

source

fn try_concat(self) -> TryConcat<Self>where
 Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
 Self::Ok: IntoIterator,
 Self::Ok: Default,

Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

source

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self>where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,

Attempt to execute several futures from a stream concurrently (unordered). Read more

source

fn try_buffered(self, n: usize) -> TryBuffered<Self>where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,

Attempt to execute several futures from a stream concurrently. Read more

source

fn try_poll_next_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Option<Result<Self::Ok, Self::Error>>>where
 Self: Unpin,

A convenience method for calling TryStream::try_poll_next on Unpin stream types. Read more

source

fn into_async_read(self) -> IntoAsyncRead<Self>where
Self: TryStreamExt<Error = Error>,
Self::Ok: AsRef<[u8]>,

Available on crate feature io only.

Adapter that converts this stream into an AsyncBufRead. Read more

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct tokio_util::codec::Framed

Implementations

impl<T, U> Framed<T, U>where T: AsyncRead + AsyncWrite,

pub fn new(inner: T, codec: U) -> Framed<T, U>

pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U>

impl<T, U> Framed<T, U>

pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>

pub fn get_ref(&self) -> &T

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

pub fn codec(&self) -> &U

pub fn codec_mut(&mut self) -> &mut U

pub fn map_codec<C, F>(self, map: F) -> Framed<T, C>where F: FnOnce(U) -> C,

pub fn codec_pin_mut(self: Pin<&mut Self>) -> &mut U

pub fn read_buffer(&self) -> &BytesMut

pub fn read_buffer_mut(&mut self) -> &mut BytesMut

pub fn write_buffer(&self) -> &BytesMut

pub fn write_buffer_mut(&mut self) -> &mut BytesMut

pub fn into_inner(self) -> T

pub fn into_parts(self) -> FramedParts<T, U>

Trait Implementations

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

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

impl<T, I, U> Sink<I> for Framed<T, U>where T: AsyncWrite, U: Encoder<I>, U::Error: From<Error>,

type Error = <U as Encoder<I>>::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, U> Stream for Framed<T, U>where T: AsyncRead, U: Decoder,

type Item = Result<<U as Decoder>::Item, <U as Decoder>::Error>

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

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

impl<'__pin, T, U> Unpin for Framed<T, U>where __Origin<'__pin, T, U>: Unpin,

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Framed<T, U>where T: RefUnwindSafe, U: RefUnwindSafe,

impl<T, U> Send for Framed<T, U>where T: Send, U: Send,

impl<T, U> Sync for Framed<T, U>where T: Sync, U: Sync,

impl<T, U> UnwindSafe for Framed<T, U>where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T, Item> SinkExt<Item> for Twhere T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

fn close(&mut self) -> Close<'_, Self, Item>where Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where Item: Clone, Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>where Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>where Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where Self: Unpin,

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>where St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized, Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>where Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self>where Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where Self: Unpin,

fn poll_flush_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

impl<T> StreamExt for Twhere T: Stream + ?Sized,

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

fn into_future(self) -> StreamFuture<Self>where Self: Unpin,

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

fn enumerate(self) -> Enumerate<Self>

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

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

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where F: FnMut(Self::Item) -> Fut, Fut: Future,

fn collect<C>(self) -> Collect<Self, C>where C: Default + Extend<Self::Item>,

impl<T, U> Framed<T, U>where
T: AsyncRead + AsyncWrite,

pub fn map_codec<C, F>(self, map: F) -> Framed<T, C>where
F: FnOnce(U) -> C,

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

impl<T, I, U> Sink<I> for Framed<T, U>where
T: AsyncWrite,
U: Encoder<I>,
U::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, U> Stream for Framed<T, U>where
T: AsyncRead,
U: Decoder,

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

impl<'pin, T, U> Unpin for Framed<T, U>where
Origin<'__pin, T, U>: Unpin,

impl<T, U> RefUnwindSafe for Framed<T, U>where
T: RefUnwindSafe,
U: RefUnwindSafe,

impl<T, U> Send for Framed<T, U>where
T: Send,
U: Send,

impl<T, U> Sync for Framed<T, U>where
T: Sync,
U: Sync,

impl<T, U> UnwindSafe for Framed<T, U>where
T: UnwindSafe,
U: UnwindSafe,

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

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

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

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

impl<T, Item> SinkExt<Item> for Twhere
T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where
F: FnOnce(Self::Error) -> E,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where
Self::Error: Into<E>,

fn close(&mut self) -> Close<'_, Self, Item>where
Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>where
Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>where
Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where
Self: Unpin,

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>where
Si2: Sink<Item, Error = Self::Error>,

fn right_sink<Si1>(self) -> Either<Si1, Self>where
Si1: Sink<Item, Error = Self::Error>,

fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,

fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

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

fn into_future(self) -> StreamFuture<Self>where
Self: Unpin,

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

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

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

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future,

fn collect<C>(self) -> Collect<Self, C>where
C: Default + Extend<Self::Item>,

fn unzip<A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB>where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Stream<Item = (A, B)>,

fn concat(self) -> Concat<Self>where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,

fn cycle(self) -> Cycle<Self>where
Self: Clone,

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F>where
F: FnMut(T, Self::Item) -> Fut,
Fut: Future<Output = T>,

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,

fn flatten(self) -> Flatten<Self>where
Self::Item: Stream,

fn flatten_unordered(
self,
limit: impl Into<Option<usize>>
) -> FlattenUnordered<Self>where
Self::Item: Stream,
Self::Item: Unpin,

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
F: FnMut(Self::Item) -> U,
U: Stream,

fn flat_map_unordered<U, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> FlatMapUnordered<Self, U, F>where
U: Stream + Unpin,
F: FnMut(Self::Item) -> U,

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option<B>>,

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

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

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where
Fut: Future,

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,

fn for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,

fn catch_unwind(self) -> CatchUnwind<Self>where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Stream<Item = Self::Item> + Send + 'a, Global>>where
Self: 'a + Send,

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>>where
Self: 'a,

fn buffered(self, n: usize) -> Buffered<Self>where
Self::Item: Future,

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where
Self::Item: Future,

fn zip<St>(self, other: St) -> Zip<Self, St>where
St: Stream,

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

fn forward<S>(self, sink: S) -> Forward<Self, S>where
S: Sink<Self::Ok, Error = Self::Error>,
Self: TryStream,

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where
Self: Sink<Item>,

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),

fn left_stream<B>(self) -> Either<Self, B>where
B: Stream<Item = Self::Item>,

fn right_stream<B>(self) -> Either<B, Self>where
B: Stream<Item = Self::Item>,

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where
Self: Unpin,

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>where
Self: Unpin + FusedStream,

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

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

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

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

impl<S> TryStreamExt for Swhere
S: TryStream + ?Sized,

fn err_into<E>(self) -> ErrInto<Self, E>where
Self::Error: Into<E>,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnMut(Self::Ok) -> T,