Trait tokio_buf::util::BufStreamExt

pub trait BufStreamExt: BufStream {
    fn chain<T>(self, other: T) -> Chain<Self, T>
    where
        Self: Sized,
        T: BufStream<Error = Self::Error>,
    { ... }
    fn collect<T>(self) -> Collect<Self, T>
    where
        Self: Sized,
        T: FromBufStream<Self::Item>,
    { ... }
    fn limit(self, amount: u64) -> Limit<Self>
    where
        Self: Sized,
    { ... }
    fn into_stream(self) -> IntoStream<Self>
    where
        Self: Sized,
    { ... }
}

An extension trait for BufStream's that provides a variety of convenient adapters.

Provided methods

fn chain<T>(self, other: T) -> Chain<Self, T> where
    Self: Sized,
    T: BufStream<Error = Self::Error>, 

Takes two buf streams and creates a new buf stream over both in sequence.

chain() returns a new BufStream value which will first yield all data from self then all data from other.

In other words, it links two buf streams together, in a chain.

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

Consumes all data from self, storing it in byte storage of type T.

collect() returns a future that buffers all data yielded from self into storage of type of T. The future completes once self yield None, returning the buffered data.

The collect future will yield an error if self yields an error or if the collect operation errors. The collect error cases are dependent on the target storage type.

fn limit(self, amount: u64) -> Limit<Self> where
    Self: Sized, 

Limit the number of bytes that the stream can yield.

limit() returns a new BufStream value which yields all the data from self while ensuring that at most amount bytes are yielded.

If self can yield greater than amount bytes, the returned stream will yield an error.

fn into_stream(self) -> IntoStream<Self> where
    Self: Sized, 

Creates a Stream from a BufStream.

This produces a Stream of BufStream::Items.

Loading content...

Implementors

impl<T> BufStreamExt for T where
    T: BufStream, 

Loading content...