[−][src]Struct futures::stream::FuturesUnordered
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 collect
ing an
iterator of futures into a FuturesUnordered
, or by
push
ing 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.
Methods
impl<Fut> FuturesUnordered<Fut> where
Fut: Future,
[src]
Fut: Future,
pub fn new() -> FuturesUnordered<Fut>
[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]
pub fn len(&self) -> usize
[src]
Returns the number of futures contained in the set.
This represents the total number of in-flight futures.
pub fn is_empty(&self) -> bool
[src]
Returns true
if the set contains no futures.
pub fn push(&mut self, future: Fut)
[src]
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.
ⓘImportant traits for IterMut<'a, Fut>pub fn iter_mut(&mut self) -> IterMut<Fut> where
Fut: Unpin,
[src]
Fut: Unpin,
Returns an iterator that allows modifying each future in the set.
ⓘImportant traits for IterPinMut<'a, Fut>pub fn iter_pin_mut(
self: Pin<&'a mut FuturesUnordered<Fut>>
) -> IterPinMut<'a, Fut>
[src]
self: Pin<&'a mut FuturesUnordered<Fut>>
) -> IterPinMut<'a, Fut>
Returns an iterator that allows modifying each future in the set.
Trait Implementations
impl<Fut> Unpin for FuturesUnordered<Fut>
[src]
impl<Fut> Sync for FuturesUnordered<Fut> where
Fut: Sync,
[src]
Fut: Sync,
impl<Fut> Default for FuturesUnordered<Fut> where
Fut: Future,
[src]
Fut: Future,
fn default() -> FuturesUnordered<Fut>
[src]
impl<Fut> Send for FuturesUnordered<Fut> where
Fut: Send,
[src]
Fut: Send,
impl<'a> LocalSpawn for FuturesUnordered<LocalFutureObj<'a, ()>>
[src]
fn spawn_local_obj(
&mut self,
future_obj: LocalFutureObj<'static, ()>
) -> Result<(), SpawnError>
[src]
&mut self,
future_obj: LocalFutureObj<'static, ()>
) -> Result<(), SpawnError>
default fn status_local(&self) -> Result<(), SpawnError>
[src]
Determines whether the executor is able to spawn new tasks. Read more
impl<'a> Spawn for FuturesUnordered<FutureObj<'a, ()>>
[src]
fn spawn_obj(
&mut self,
future_obj: FutureObj<'static, ()>
) -> Result<(), SpawnError>
[src]
&mut self,
future_obj: FutureObj<'static, ()>
) -> Result<(), SpawnError>
default fn status(&self) -> Result<(), SpawnError>
[src]
Determines whether the executor is able to spawn new tasks. Read more
impl<Fut> FusedStream for FuturesUnordered<Fut> where
Fut: Future,
[src]
Fut: Future,
fn is_terminated(&self) -> bool
[src]
impl<Fut> Stream for FuturesUnordered<Fut> where
Fut: Future,
[src]
Fut: Future,
type Item = <Fut as Future>::Output
Values yielded by the stream.
fn poll_next(
self: Pin<&mut FuturesUnordered<Fut>>,
cx: &mut Context
) -> Poll<Option<<FuturesUnordered<Fut> as Stream>::Item>>
[src]
self: Pin<&mut FuturesUnordered<Fut>>,
cx: &mut Context
) -> Poll<Option<<FuturesUnordered<Fut> as Stream>::Item>>
impl<Fut> Debug for FuturesUnordered<Fut>
[src]
impl<Fut> Drop for FuturesUnordered<Fut>
[src]
impl<Fut> FromIterator<Fut> for FuturesUnordered<Fut> where
Fut: Future,
[src]
Fut: Future,
fn from_iter<I>(iter: I) -> FuturesUnordered<Fut> where
I: IntoIterator<Item = Fut>,
[src]
I: IntoIterator<Item = Fut>,
Blanket Implementations
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>>,
[src]
S: Stream<Item = Result<T, E>>,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>
[src]
self: Pin<&mut S>,
cx: &mut Context
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>
impl<T> StreamExt for T where
T: Stream + ?Sized,
[src]
T: Stream + ?Sized,
ⓘImportant traits for Next<'_, St>default fn next(&mut self) -> Next<Self> where
Self: Unpin,
[src]
Self: Unpin,
Creates a future that resolves to the next item in the stream. Read more
ⓘImportant traits for StreamFuture<St>default fn into_future(self) -> StreamFuture<Self> where
Self: Unpin,
[src]
Self: Unpin,
Converts this stream into a future of (next_item, tail_of_stream)
. If the stream terminates, then the next item is [None
]. Read more
default fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,
[src]
F: FnMut(Self::Item) -> T,
Maps this stream's items to a different type, returning a new stream of the resulting type. Read more
default fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
[src]
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Filters the values produced by this stream according to the provided asynchronous predicate. Read more
default fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = Option<T>>,
[src]
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = Option<T>>,
Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more
default fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnMut(Self::Item) -> Fut,
Fut: Future,
[src]
F: FnMut(Self::Item) -> Fut,
Fut: Future,
Computes from this stream's items new items of a different type using an asynchronous closure. Read more
ⓘImportant traits for Collect<St, C>default fn collect<C>(self) -> Collect<Self, C> where
C: Default + Extend<Self::Item>,
[src]
C: Default + Extend<Self::Item>,
Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
ⓘImportant traits for Concat<St>default fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,
[src]
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,
Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more
ⓘImportant traits for Fold<St, Fut, T, F>default fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
F: FnMut(T, Self::Item) -> Fut,
Fut: Future<Output = T>,
[src]
F: FnMut(T, Self::Item) -> Fut,
Fut: Future<Output = T>,
Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more
default fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
[src]
Self::Item: Stream,
Flattens a stream of streams into just one continuous stream. Read more
default fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
[src]
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Skip elements on this stream while the provided asynchronous predicate resolves to true
. Read more
default fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
[src]
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Take elements from this stream while the provided asynchronous predicate resolves to true
. Read more
ⓘImportant traits for ForEach<St, Fut, F>default fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
[src]
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more
ⓘImportant traits for ForEachConcurrent<St, Fut, F>default fn for_each_concurrent<Fut, F, impl Into
[src]
Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more
default fn take(self, n: u64) -> Take<Self>
[src]
Creates a new stream of at most n
items of the underlying stream. Read more
default fn skip(self, n: u64) -> Skip<Self>
[src]
Creates a new stream which skips n
items of the underlying stream. Read more
default fn fuse(self) -> Fuse<Self>
[src]
Fuse a stream such that poll_next
will never again be called once it has finished. This method can be used t turn any Stream
into a FusedStream
. Read more
ⓘImportant traits for &'_ mut Fdefault fn by_ref(&mut self) -> &mut Self
[src]
Borrows a stream, rather than consuming it. Read more
default fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
Catches unwinding panics while polling the stream. Read more
ⓘImportant traits for Pin<P>default fn boxed(self) -> Pin<Box<Self>>
[src]
Wrap the stream in a Box, pinning it.
default fn buffered(self, n: usize) -> Buffered<Self> where
Self::Item: Future,
[src]
Self::Item: Future,
An adaptor for creating a buffered list of pending futures. Read more
default fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
Self::Item: Future,
[src]
Self::Item: Future,
An adaptor for creating a buffered list of pending futures (unordered). Read more
default fn zip<St>(self, other: St) -> Zip<Self, St> where
St: Stream,
[src]
St: Stream,
An adapter for zipping two streams together. Read more
default fn chain<St>(self, other: St) -> Chain<Self, St> where
St: Stream<Item = Self::Item>,
[src]
St: Stream<Item = Self::Item>,
Adapter for chaining two stream. Read more
default fn peekable(self) -> Peekable<Self>
[src]
Creates a new stream which exposes a peek
method. Read more
default fn chunks(self, capacity: usize) -> Chunks<Self>
[src]
An adaptor for chunking up items of the stream inside a vector. Read more
default fn select<St>(self, other: St) -> Select<Self, St> where
St: Stream<Item = Self::Item>,
[src]
St: Stream<Item = Self::Item>,
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
ⓘImportant traits for Forward<St, Si>default fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<Self::Ok>,
Self: TryStream<Error = <S as Sink<Self::Ok>>::SinkError>,
[src]
S: Sink<Self::Ok>,
Self: TryStream<Error = <S as Sink<Self::Ok>>::SinkError>,
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
default fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
Self: Sink<Item>,
[src]
Self: Sink<Item>,
Splits this Stream + Sink
object into separate Stream
and Sink
objects. Read more
default fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item),
[src]
F: FnMut(&Self::Item),
Do something with each item of this stream, afterwards passing it on. Read more
default fn left_stream<B>(self) -> Either<Self, B> where
B: Stream<Item = Self::Item>,
[src]
B: Stream<Item = Self::Item>,
Wrap this stream in an Either
stream, making it the left-hand variant of that Either
. Read more
default fn right_stream<B>(self) -> Either<B, Self> where
B: Stream<Item = Self::Item>,
[src]
B: Stream<Item = Self::Item>,
Wrap this stream in an Either
stream, making it the right-hand variant of that Either
. Read more
default fn poll_next_unpin(
&mut self,
cx: &mut Context
) -> Poll<Option<Self::Item>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context
) -> Poll<Option<Self::Item>> where
Self: Unpin,
A convenience method for calling [Stream::poll_next
] on [Unpin
] stream types. Read more
ⓘImportant traits for SelectNextSome<'a, St>default fn select_next_some(&mut self) -> SelectNextSome<Self> where
Self: Unpin + FusedStream,
[src]
Self: Unpin + FusedStream,
Returns a [Future
] that resolves when the next item in this stream is ready. Read more
impl<S> TryStreamExt for S where
S: TryStream,
[src]
S: TryStream,
default fn err_into<E>(self) -> ErrInto<Self, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
Wraps the current stream in a new stream which converts the error type into the one provided. Read more
default fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnMut(Self::Ok) -> T,
[src]
F: FnMut(Self::Ok) -> T,
Wraps the current stream in a new stream which maps the success value using the provided closure. Read more
default fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> E,
[src]
F: FnMut(Self::Error) -> E,
Wraps the current stream in a new stream which maps the error value using the provided closure. Read more
default fn into_stream(self) -> IntoStream<Self>
[src]
Wraps a [TryStream
] into a type that implements Stream
Read more
ⓘImportant traits for TryNext<'_, St>default fn try_next(&mut self) -> TryNext<Self> where
Self: Unpin,
[src]
Self: Unpin,
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
ⓘImportant traits for TryForEach<St, Fut, F>default fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = Self::Error>,
[src]
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = (), Error = Self::Error>,
Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more
default fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
[src]
F: FnMut(&Self::Ok) -> Fut,
Fut: TryFuture<Ok = bool, Error = Self::Error>,
Skip elements on this stream while the provided asynchronous predicate resolves to true
. Read more
ⓘImportant traits for TryForEachConcurrent<St, Fut, F>default fn try_for_each_concurrent<Fut, F, impl Into>>(
self,
limit: impl Into >,
f: F
) -> TryForEachConcurrent<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: Future<Output = Result<(), Self::Error>>,
impl Into>: Into<Option<usize>>,
[src]
self,
limit: impl Into
f: F
) -> TryForEachConcurrent<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: Future<Output = Result<(), Self::Error>>,
impl Into
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
ⓘImportant traits for TryCollect<St, C>default fn try_collect<C>(self) -> TryCollect<Self, C> where
C: Default + Extend<Self::Ok>,
[src]
C: Default + Extend<Self::Ok>,
Attempt to Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
default fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
[src]
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,
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
ⓘImportant traits for TryFold<St, Fut, T, F>default fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where
F: FnMut(T, Self::Ok) -> Fut,
Fut: TryFuture<Ok = T, Error = Self::Error>,
[src]
F: FnMut(T, Self::Ok) -> Fut,
Fut: TryFuture<Ok = T, Error = Self::Error>,
Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more
ⓘImportant traits for TryConcat<St>default fn try_concat(self) -> TryConcat<Self> where
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
Self::Ok: IntoIterator,
Self::Ok: Default,
[src]
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
Self::Ok: IntoIterator,
Self::Ok: Default,
Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more
default fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
[src]
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Attempt to execute several futures from a stream concurrently. Read more
default fn try_poll_next_unpin(
&mut self,
cx: &mut Context
) -> Poll<Option<Result<Self::Ok, Self::Error>>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context
) -> Poll<Option<Result<Self::Ok, Self::Error>>> where
Self: Unpin,
A convenience method for calling [TryStream::poll_next_unpin
] on [Unpin
] stream types. Read more
ⓘImportant traits for Compat<R>default fn compat(self) -> Compat<Self> where
Self: Unpin,
[src]
Self: Unpin,
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}; # let (tx, rx) = futures::channel::oneshot::channel(); Read more
default fn into_async_read(self) -> IntoAsyncRead<Self> where
Self: TryStreamExt<Error = Error> + Unpin,
Self::Ok: AsRef<[u8]>,
[src]
Self: TryStreamExt<Error = Error> + Unpin,
Self::Ok: AsRef<[u8]>,
Adapter that converts this stream into an [AsyncRead
]. Read more
impl<Sp> SpawnExt for Sp where
Sp: Spawn + ?Sized,
[src]
Sp: Spawn + ?Sized,
default fn spawn<Fut>(&mut self, future: Fut) -> Result<(), SpawnError> where
Fut: Future<Output = ()> + Send + 'static,
[src]
Fut: Future<Output = ()> + Send + 'static,
Spawns a task that polls the given future with output ()
to completion. Read more
default fn spawn_with_handle<Fut>(
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + Send + 'static,
<Fut as Future>::Output: Send,
[src]
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + Send + 'static,
<Fut as Future>::Output: Send,
Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future's output. Read more
ⓘImportant traits for Compat<R>default fn compat(self) -> Compat<Self>
[src]
Wraps a [Spawn
] and makes it usable as a futures 0.1 Executor
. Requires the compat
feature to enable. Read more
impl<Sp> LocalSpawnExt for Sp where
Sp: LocalSpawn + ?Sized,
[src]
Sp: LocalSpawn + ?Sized,
default fn spawn_local<Fut>(&mut self, future: Fut) -> Result<(), SpawnError> where
Fut: Future<Output = ()> + 'static,
[src]
Fut: Future<Output = ()> + 'static,
Spawns a task that polls the given future with output ()
to completion. Read more
default fn spawn_local_with_handle<Fut>(
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + 'static,
[src]
&mut self,
future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
Fut: Future + 'static,
Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future's output. Read more