[][src]Struct futures::stream::FuturesUnordered

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

A set of futures which may complete in any order.

This structure is optimized to manage a large number of futures. Futures managed by FuturesUnordered will only be polled when they generate wake-up notifications. This reduces the required amount of work needed to poll large numbers of futures.

FuturesUnordered can be filled by collecting an iterator of futures into a FuturesUnordered, or by pushing futures onto an existing FuturesUnordered. When new futures are added, poll_next must be called in order to begin receiving wake-ups for new futures.

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

Methods

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

Constructs a new, empty FuturesUnordered.

The returned FuturesUnordered does not contain any futures. In this state, FuturesUnordered::poll_next will return Poll::Ready(None).

impl<Fut> FuturesUnordered<Fut>
[src]

Returns the number of futures contained in the set.

This represents the total number of in-flight futures.

Returns true if the set contains no futures.

Push a future into the set.

This method adds the given future to the set. This method will not call poll on the submitted future. The caller must ensure that FuturesUnordered::poll_next is called in order to receive wake-up notifications for the given future.

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

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

Trait Implementations

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

Executes the destructor for this type. Read more

impl<Fut> Unpin for FuturesUnordered<Fut>
[src]

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

Creates a value from an iterator. Read more

impl<Fut> Default for FuturesUnordered<Fut> where
    Fut: Future
[src]

Returns the "default value" for a type. Read more

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

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

Values yielded by the stream.

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

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

impl<Fut> Debug for FuturesUnordered<Fut>
[src]

Formats the value using the given formatter. Read more

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Important traits for &'a mut I

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Important traits for &'a mut I

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

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

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is [None]. Read more

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

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

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

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

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

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

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

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

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

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

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

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

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

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

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

Important traits for &'a mut I

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

Wrap the stream in a Box, pinning it.

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

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

An adapter for zipping two streams together. Read more

Adapter for chaining two stream. Read more

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

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

This combinator will attempt to pull items from both streams. Each stream will be polled in a round-robin fashion, and whenever a stream is ready to yield an item that item is yielded. Read more

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

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

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

Important traits for Either<L, R>

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

Important traits for Either<L, R>

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

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

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>>, 
[src]

The type of successful values yielded by this future

The type of failures yielded by this future

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

impl<S> TryStreamExt for S where
    S: TryStream
[src]

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

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

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

Wraps a [TryStream] into a type that implements Stream Read more

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

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

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

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

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

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

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

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

Wraps a [TryStream] into a stream compatible with libraries using futures 0.1 Stream. Requires the compat feature to be enabled. ``` #![feature(async_await, await_macro, futures_api)] use futures::future::{FutureExt, TryFutureExt}; use futures::spawn; use futures::compat::TokioDefaultSpawner; # let (tx, rx) = futures::channel::oneshot::channel(); Read more