BatchStream

Struct BatchStream 

Source
pub struct BatchStream<S>
where S: Stream,
{ /* private fields */ }
Expand description

It’s a combinator that converts Stream<A> into Stream<Vec<A>>. So interface is similar to .chunks() method, but there’s an important difference: BatchStream won’t wait until the whole batch fills up i.e. as soon as underlying stream return NotReady, then new batch is returned from BatchStream

Implementations§

Source§

impl<S: Stream> BatchStream<S>

Source

pub fn new(s: S, limit: usize) -> Self

Return an instance of BatchStream wrapping a Stream with the provided limit set

Trait Implementations§

Source§

impl<S: Stream> Stream for BatchStream<S>

Source§

type Item = Vec<<S as Stream>::Item>

The type of item this stream will yield on success.
Source§

type Error = <S as Stream>::Error

The type of error this stream may generate.
Source§

fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more
Source§

fn wait(self) -> Wait<Self>
where Self: Sized,

Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more
Source§

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

Converts this stream into a Future. Read more
Source§

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

Converts a stream of type T to a stream of type U. Read more
Source§

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

Converts a stream of error type T to a stream of error type U. Read more
Source§

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

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

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

Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
Source§

fn then<F, U>(self, f: F) -> Then<Self, F, U>
where F: FnMut(Result<Self::Item, Self::Error>) -> U, U: IntoFuture, Self: Sized,

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more
Source§

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U>
where F: FnMut(Self::Item) -> U, U: IntoFuture<Error = Self::Error>, Self: Sized,

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<F, U>(self, f: F) -> OrElse<Self, F, U>
where F: FnMut(Self::Error) -> U, U: IntoFuture<Item = Self::Item>, Self: Sized,

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

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

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
Source§

fn concat2(self) -> Concat2<Self>
where Self: Sized, Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,

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

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

👎Deprecated since 0.1.14: please use Stream::concat2 instead
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
Source§

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T>
where F: FnMut(T, Self::Item) -> Fut, Fut: IntoFuture<Item = T>, Self::Error: From<<Fut as IntoFuture>::Error>, Self: Sized,

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

fn flatten(self) -> Flatten<Self>
where Self::Item: Stream, <Self::Item as Stream>::Error: From<Self::Error>, Self: Sized,

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

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R>
where P: FnMut(&Self::Item) -> R, R: IntoFuture<Item = bool, Error = Self::Error>, Self: Sized,

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

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R>
where P: FnMut(&Self::Item) -> R, R: IntoFuture<Item = bool, Error = Self::Error>, Self: Sized,

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

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U>
where F: FnMut(Self::Item) -> U, U: IntoFuture<Item = (), Error = Self::Error>, Self: Sized,

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

fn from_err<E>(self) -> FromErr<Self, E>
where E: From<Self::Error>, Self: Sized,

Map this stream’s error to any error implementing From for this stream’s Error, returning a new stream. Read more
Source§

fn take(self, amt: u64) -> Take<Self>
where Self: Sized,

Creates a new stream of at most amt items of the underlying stream. Read more
Source§

fn skip(self, amt: u64) -> Skip<Self>
where Self: Sized,

Creates a new stream which skips amt items of the underlying stream. Read more
Source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Fuse a stream such that poll will never again be called once it has finished. Read more
Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Borrows a stream, rather than consuming it. Read more
Source§

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

Catches unwinding panics while polling the stream. Read more
Source§

fn buffered(self, amt: usize) -> Buffered<Self>
where Self::Item: IntoFuture<Error = Self::Error>, Self: Sized,

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

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self>
where Self::Item: IntoFuture<Error = Self::Error>, Self: Sized,

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

fn merge<S>(self, other: S) -> Merge<Self, S>
where S: Stream<Error = Self::Error>, Self: Sized,

👎Deprecated: functionality provided by select now
An adapter for merging the output of two streams. Read more
Source§

fn zip<S>(self, other: S) -> Zip<Self, S>
where S: Stream<Error = Self::Error>, Self: Sized,

An adapter for zipping two streams together. Read more
Source§

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

Adapter for chaining two stream. Read more
Source§

fn peekable(self) -> Peekable<Self>
where Self: Sized,

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

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

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

fn select<S>(self, other: S) -> Select<Self, S>
where S: Stream<Item = Self::Item, Error = Self::Error>, Self: Sized,

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more
Source§

fn forward<S>(self, sink: S) -> Forward<Self, S>
where S: Sink<SinkItem = Self::Item>, Self::Error: From<<S as Sink>::SinkError>, Self: Sized,

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

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

Do something with each item 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), Self: Sized,

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

Auto Trait Implementations§

§

impl<S> Freeze for BatchStream<S>
where S: Freeze, <S as Stream>::Error: Freeze,

§

impl<S> RefUnwindSafe for BatchStream<S>

§

impl<S> Send for BatchStream<S>
where S: Send, <S as Stream>::Error: Send,

§

impl<S> Sync for BatchStream<S>
where S: Sync, <S as Stream>::Error: Sync,

§

impl<S> Unpin for BatchStream<S>
where S: Unpin, <S as Stream>::Error: Unpin,

§

impl<S> UnwindSafe for BatchStream<S>
where S: UnwindSafe, <S as Stream>::Error: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> StreamExt for T
where T: Stream,

Source§

fn streamfork<Out1, Out2, F, E>( self, out1: Out1, out2: Out2, pred: F, ) -> Forker<Self, Out1, Out2, F, E>
where Self: Sized, Out1: Sink<SinkItem = Self::Item>, Out2: Sink<SinkItem = Self::Item, SinkError = Out1::SinkError>, F: FnMut(&Self::Item) -> Result<bool, E>, E: From<Self::Error> + From<Out1::SinkError> + From<Out2::SinkError>,

Fork elements in a stream out to two sinks, depending on a predicate Read more
Source§

fn collect_no_consume(self) -> CollectNoConsume<Self>
where Self: Sized,

Returns a future that yields a (Vec<<Self>::Item>, Self), where the vector is a collections of all elements yielded by the Stream.
Source§

fn encode<Enc>(self, encoder: Enc) -> LayeredEncoder<Self, Enc>
where Self: Sized, Enc: Encoder<Item = Self::Item>,

A shorthand for encode::encode
Source§

fn enumerate(self) -> Enumerate<Self>
where Self: Sized,

Similar to std::iter::Iterator::enumerate, returns a Stream that yields (usize, Self::Item) where the first element of tuple is the iteration count.
Source§

fn return_remainder(self) -> (ReturnRemainder<Self>, ConservativeReceiver<Self>)
where Self: Sized,

Creates a stream wrapper and a future. The future will resolve into the wrapped stream when the stream wrapper returns None. It uses ConservativeReceiver to ensure that deadlocks are easily caught when one tries to poll on the receiver before consuming the stream.
Source§

fn is_empty<'a>( self, ) -> Box<dyn Future<Item = bool, Error = Self::Error> + Send + 'a>
where Self: 'a + Send + Sized,

Whether this stream is empty. Read more
Source§

fn not_empty<'a>( self, ) -> Box<dyn Future<Item = bool, Error = Self::Error> + Send + 'a>
where Self: 'a + Send + Sized,

Whether this stream is not empty (has at least one element). Read more
Source§

fn boxify(self) -> BoxStream<Self::Item, Self::Error>
where Self: 'static + Send + Sized,

Create a Sendable boxed version of this Stream.
Source§

fn boxify_nonsend(self) -> BoxStreamNonSend<Self::Item, Self::Error>
where Self: 'static + Sized,

Create a non-Sendable boxed version of this Stream.
Source§

fn left_stream<B>(self) -> StreamEither<Self, B>
where Self: Sized,

Shorthand for returning StreamEither::A
Source§

fn right_stream<A>(self) -> StreamEither<A, Self>
where Self: Sized,

Shorthand for returning StreamEither::B
Source§

fn batch(self, limit: usize) -> BatchStream<Self>
where Self: Sized,

Similar to Stream::chunks, but returns earlier if futures::Async::NotReady was returned.
Source§

fn buffered_weight_limited<I, E, Fut>( self, params: BufferedParams, ) -> WeightLimitedBufferedStream<Self, I, E>
where Self: Sized + Send + 'static + Stream<Item = (Fut, u64), Error = E>, Fut: Future<Item = I, Error = E>,

Like Stream::buffered call, but can also limit number of futures in a buffer by “weight”.
Source§

fn collect_to<C: Default + Extend<Self::Item>>(self) -> CollectTo<Self, C>
where Self: Sized,

Returns a Future that yields a collection C containing all Self::Item yielded by the stream
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.