Struct tokio::prelude::stream::FuturesUnordered [] [src]

#[must_use = "streams do nothing unless polled"]
pub struct FuturesUnordered<F> { /* fields omitted */ }

An unbounded set of futures.

This "combinator" also serves a special function in this library, providing the ability to maintain a set of futures that and manage driving them all to completion.

Futures are pushed into this set and their realized values are yielded as they are ready. This structure is optimized to manage a large number of futures. Futures managed by FuturesUnordered will only be polled when they generate notifications. This reduces the required amount of work needed to coordinate large numbers of futures.

When a FuturesUnordered is first created, it does not contain any futures. Calling poll in this state will result in Ok(Async::Ready(None)) to be returned. Futures are submitted to the set using push; however, the future will not be polled at this point. FuturesUnordered will only poll managed futures when FuturesUnordered::poll is called. As such, it is important to call poll after pushing new futures.

If FuturesUnordered::poll returns Ok(Async::Ready(None)) this means that the set is currently not managing any futures. A future may be submitted to the set at a later time. At that point, a call to FuturesUnordered::poll will either return the future's resolved value or Ok(Async::NotReady) if the future has not yet completed.

Note that you can create a ready-made FuturesUnordered via the futures_unordered function in the stream module, or you can start with an empty set with the FuturesUnordered::new constructor.

Methods

impl<T> FuturesUnordered<T> where
    T: Future
[src]

[src]

Constructs a new, empty FuturesUnordered

The returned FuturesUnordered does not contain any futures and, in this state, FuturesUnordered::poll will return Ok(Async::Ready(None)).

impl<T> FuturesUnordered<T>
[src]

[src]

Returns the number of futures contained in the set.

This represents the total number of in-flight futures.

[src]

Returns true if the set contains no futures

[src]

Push a future into the set.

This function submits the given future to the set for managing. This function will not call poll on the submitted future. The caller must ensure that FuturesUnordered::poll is called in order to receive task notifications.

Important traits for IterMut<'a, F>
[src]

Returns an iterator that allows modifying each future in the set.

Trait Implementations

impl<T> Sync for FuturesUnordered<T> where
    T: Sync
[src]

impl<F> FromIterator<F> for FuturesUnordered<F> where
    F: Future
[src]

[src]

Creates a value from an iterator. Read more

impl<T> Debug for FuturesUnordered<T> where
    T: Debug
[src]

[src]

Formats the value using the given formatter. Read more

impl<T> Stream for FuturesUnordered<T> where
    T: Future
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

[src]

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

Important traits for Wait<S>
[src]

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

[src]

Converts this stream into a Future. Read more

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

Important traits for &'a mut R
[src]

Borrows a stream, rather than consuming it. Read more

[src]

Catches unwinding panics while polling the stream. Read more

[src]

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

[src]

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

[src]

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams. Read more

[src]

An adapter for zipping two streams together. Read more

[src]

Adapter for chaining two stream. Read more

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

impl<T> Drop for FuturesUnordered<T>
[src]

[src]

Executes the destructor for this type. Read more

impl<T> Send for FuturesUnordered<T> where
    T: Send
[src]