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

pub struct FuturesUnordered<Fut> { /* fields omitted */ }
Expand description

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 collect method, or you can start with an empty set with the FuturesUnordered::new constructor.

This type is only available when the std or alloc feature of this library is activated, and it is activated by default.

Implementations

Constructs a new, empty FuturesUnordered.

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

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 inspecting each future in the set.

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

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

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

Clears the set, removing all futures.

Trait Implementations

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Executes the destructor for this type. Read more

Extends a collection with the contents of an iterator. Read more

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

Extends a collection with exactly one element.

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

Reserves capacity in a collection for the given number of additional elements. Read more

Creates a value from an iterator. Read more

Returns true if the stream should no longer be polled.

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

Spawns a future that will be run to completion. Read more

Determines whether the executor is able to spawn new tasks. Read more

Spawns a future that will be run to completion. Read more

Determines whether the executor is able to spawn new tasks. Read more

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

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

Spawns a task that polls the given future with output () to completion. Read more

Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future’s output. Read more

Spawns a task that polls the given future with output () to completion. Read more

Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future’s output. Read more

Wraps a Spawn and makes it usable as a futures 0.1 Executor. Requires the compat feature to enable. Read more

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

Creates a stream which gives the current iteration count as well as the next value. 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

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

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

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

Repeats a stream endlessly. Read more

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

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

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

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

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

Combinator similar to StreamExt::fold that holds internal state and produces a new 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

Take elements from this stream until the provided future resolves. 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. This method can be used to turn any Stream into a FusedStream. Read more

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. Read more

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

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 streams. 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

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

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

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

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

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

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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

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

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

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

Do something with the error value of this stream, afterwards passing it on. 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

Take 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 transform a stream into a collection, returning a future representing the result of that computation. Read more

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

Attempt to filter the values produced by this stream according to the provided asynchronous closure. 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

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

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

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

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

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

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

Wraps a TryStream into a stream compatible with libraries using futures 0.1 Stream. Requires the compat feature to be enabled. Read more

Adapter that converts this stream into an AsyncRead. Read more