[−][src]Struct futures::stream::SelectAll
#[must_use = "streams do nothing unless polled"]pub struct SelectAll<St> { /* fields omitted */ }
An unbounded set of streams
This "combinator" provides the ability to maintain a set of streams and drive them all to completion.
Streams are pushed into this set and their realized values are yielded as they become ready. Streams will only be polled when they generate notifications. This allows to coordinate a large number of streams.
Note that you can create a ready-made SelectAll via the
select_all function in the stream module, or you can start with an
empty set with the SelectAll::new constructor.
Implementations
impl<St> SelectAll<St> where
St: Unpin + Stream, [src][−]
St: Unpin + Stream,
pub fn new() -> SelectAll<St>[src][−]
Constructs a new, empty SelectAll
The returned SelectAll does not contain any streams and, in this
state, SelectAll::poll will return Poll::Ready(None).
pub fn len(&self) -> usize[src][−]
Returns the number of streams contained in the set.
This represents the total number of in-flight streams.
pub fn is_empty(&self) -> bool[src][−]
Returns true if the set contains no streams
pub fn push(&mut self, stream: St)[src][−]
Push a stream into the set.
This function submits the given stream to the set for managing. This
function will not call poll on the submitted stream. The caller must
ensure that SelectAll::poll is called in order to receive task
notifications.
Trait Implementations
impl<St> Debug for SelectAll<St> where
St: Debug, [src][+]
St: Debug,
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src][−]
Formats the value using the given formatter. Read more
impl<St> Default for SelectAll<St> where
St: Unpin + Stream, [src][+]
St: Unpin + Stream,
fn default() -> SelectAll<St>[src][−]
Returns the "default value" for a type. Read more
impl<St> Extend<St> for SelectAll<St> where
St: Unpin + Stream, [src][+]
St: Unpin + Stream,
fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = St>, [src][−]
T: IntoIterator<Item = St>,
Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)[src][−]
extend_one)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)[src][−]
extend_one)Reserves capacity in a collection for the given number of additional elements. Read more
impl<St> FromIterator<St> for SelectAll<St> where
St: Unpin + Stream, [src][+]
St: Unpin + Stream,
fn from_iter<T>(iter: T) -> SelectAll<St> where
T: IntoIterator<Item = St>, [src][−]
T: IntoIterator<Item = St>,
Creates a value from an iterator. Read more
impl<St> FusedStream for SelectAll<St> where
St: Unpin + Stream, [src][+]
St: Unpin + Stream,
fn is_terminated(&self) -> bool[src][−]
Returns true if the stream should no longer be polled.
impl<St> Stream for SelectAll<St> where
St: Unpin + Stream, [src][+]
St: Unpin + Stream,
type Item = <St as Stream>::Item
Values yielded by the stream.
fn poll_next(
self: Pin<&mut SelectAll<St>>,
cx: &mut Context<'_>
) -> Poll<Option<<SelectAll<St> as Stream>::Item>>[src][−]
self: Pin<&mut SelectAll<St>>,
cx: &mut Context<'_>
) -> Poll<Option<<SelectAll<St> as Stream>::Item>>
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
fn size_hint(&self) -> (usize, Option<usize>)[src][−]
Returns the bounds on the remaining length of the stream. Read more
Auto Trait Implementations
impl<St> !RefUnwindSafe for SelectAll<St>
impl<St> Send for SelectAll<St> where
St: Send,
St: Send,
impl<St> Sync for SelectAll<St> where
St: Sync,
St: Sync,
impl<St> Unpin for SelectAll<St>
impl<St> !UnwindSafe for SelectAll<St>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src][+]
T: 'static + ?Sized,
fn type_id(&self) -> TypeId[src][−]
Gets the TypeId of self. Read more
impl<T> Borrow<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
fn borrow(&self) -> &Tⓘ[src][−]
Immutably borrows from an owned value. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut Tⓘ[src][−]
Mutably borrows from an owned value. Read more
impl<T> From<T> for T[src][+]
impl<T, U> Into<U> for T where
U: From<T>, [src][+]
U: From<T>,
impl<T> StreamExt for T where
T: Stream + ?Sized, [src][+]
T: Stream + ?Sized,
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
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
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
fn enumerate(self) -> Enumerate<Self>[src][−]
Creates a stream which gives the current iteration count as well as the next value. Read more
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
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
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
fn collect<C>(self) -> Collect<Self, C>ⓘ where
C: Default + Extend<Self::Item>, [src][−]
C: Default + Extend<Self::Item>,
Transforms a stream into a collection, returning a future representing the result of that computation. Read more
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
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
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
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: Stream, [src][−]
F: FnMut(Self::Item) -> U,
U: Stream,
Maps a stream like StreamExt::map but flattens nested Streams. Read more
fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F> where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option<B>>, [src][−]
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option<B>>,
Combinator similar to StreamExt::fold that holds internal state
and produces a new stream. Read more
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
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
fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut> where
Fut: Future, [src][−]
Fut: Future,
Take elements from this stream until the provided future resolves. Read more
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
fn for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F>ⓘ where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>, [src][−]
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F>ⓘ where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more
fn take(self, n: usize) -> Take<Self>[src][−]
Creates a new stream of at most n items of the underlying stream. Read more
fn skip(self, n: usize) -> Skip<Self>[src][−]
Creates a new stream which skips n items of the underlying stream. Read more
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 to turn
any Stream into a FusedStream. Read more
fn by_ref(&mut self) -> &mut Selfⓘ[src][−]
Borrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src][−]
Self: UnwindSafe,
Catches unwinding panics while polling the stream. Read more
fn boxed<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send>>ⓘ where
Self: Send + 'a, [src][−]
Self: Send + 'a,
Wrap the stream in a Box, pinning it. Read more
fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a>>ⓘ where
Self: 'a, [src][−]
Self: 'a,
Wrap the stream in a Box, pinning it. Read more
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
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
fn zip<St>(self, other: St) -> Zip<Self, St> where
St: Stream, [src][−]
St: Stream,
An adapter for zipping two streams together. Read more
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 streams. Read more
fn peekable(self) -> Peekable<Self>[src][−]
Creates a new stream which exposes a peek method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self>[src][−]
An adaptor for chunking up items of the stream inside a vector. Read more
fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>[src][−]
An adaptor for chunking up ready items of the stream inside a vector. Read more
fn forward<S>(self, sink: S) -> Forward<Self, S>ⓘ where
S: Sink<Self::Ok, Error = Self::Error>,
Self: TryStream, [src][−]
S: Sink<Self::Ok, Error = Self::Error>,
Self: TryStream,
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
fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
Self: Sink<Item>, [src][−]
Self: Sink<Item>,
Splits this Stream + Sink object into separate Sink and Stream
objects. Read more
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
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
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
fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> where
Self: Unpin, [src][−]
Self: Unpin,
A convenience method for calling Stream::poll_next on Unpin
stream types. Read more
fn select_next_some(&mut self) -> SelectNextSome<'_, Self>ⓘNotable traits for SelectNextSome<'_, St>
impl<'_, St> Future for SelectNextSome<'_, St> where
St: Unpin + FusedStream + ?Sized, type Output = <St as Stream>::Item; where
Self: Unpin + FusedStream, [src][−]
Notable traits for SelectNextSome<'_, St>
impl<'_, St> Future for SelectNextSome<'_, St> where
St: Unpin + FusedStream + ?Sized, type Output = <St as Stream>::Item;Self: Unpin + FusedStream,
impl<T, U> TryFrom<U> 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][−]
Performs the conversion.
impl<T, U> TryInto<U> 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][−]
Performs the conversion.
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized, [src][+]
S: Stream<Item = Result<T, E>> + ?Sized,
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>>>
Poll this TryStream as if it were a Stream. Read more
impl<S> TryStreamExt for S where
S: TryStream + ?Sized, [src][+]
S: TryStream + ?Sized,
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
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
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
fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>, [src][−]
F: FnMut(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
Chain on a computation for when a value is ready, passing the successful
results to the provided closure f. Read more
fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnMut(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>, [src][−]
F: FnMut(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
Chain on a computation for when an error happens, passing the
erroneous result to the provided closure f. Read more
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnMut(&Self::Ok), [src][−]
F: FnMut(&Self::Ok),
Do something with the success value of this stream, afterwards passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnMut(&Self::Error), [src][−]
F: FnMut(&Self::Error),
Do something with the error value of this stream, afterwards passing it on. Read more
fn into_stream(self) -> IntoStream<Self>[src][−]
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
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
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
fn try_for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> TryForEachConcurrent<Self, Fut, F>ⓘ where
F: FnMut(Self::Ok) -> Fut,
Fut: Future<Output = Result<(), Self::Error>>, [src][−]
self,
limit: impl Into<Option<usize>>,
f: F
) -> TryForEachConcurrent<Self, Fut, F>ⓘ where
F: FnMut(Self::Ok) -> Fut,
Fut: Future<Output = Result<(), Self::Error>>,
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
fn try_collect<C>(self) -> TryCollect<Self, C>ⓘ where
C: Default + Extend<Self::Ok>, [src][−]
C: Default + Extend<Self::Ok>,
Attempt to transform a stream into a collection, returning a future representing the result of that computation. Read more
fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F> where
F: FnMut(&Self::Ok) -> Fut,
Fut: Future<Output = bool>, [src][−]
F: FnMut(&Self::Ok) -> Fut,
Fut: Future<Output = bool>,
Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more
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
fn try_flatten(self) -> TryFlatten<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>, [src][−]
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error: From<Self::Error>,
Flattens a stream of streams into just one continuous stream. Read more
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
fn try_concat(self) -> TryConcat<Self>ⓘNotable traits for TryConcat<St>
impl<St> Future for TryConcat<St> where
St: TryStream,
<St as TryStream>::Ok: Extend<<<St as TryStream>::Ok as IntoIterator>::Item>,
<St as TryStream>::Ok: IntoIterator,
<St as TryStream>::Ok: Default, type Output = Result<<St as TryStream>::Ok, <St as TryStream>::Error>; where
Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
Self::Ok: IntoIterator,
Self::Ok: Default, [src][−]
Notable traits for TryConcat<St>
impl<St> Future for TryConcat<St> where
St: TryStream,
<St as TryStream>::Ok: Extend<<<St as TryStream>::Ok as IntoIterator>::Item>,
<St as TryStream>::Ok: IntoIterator,
<St as TryStream>::Ok: Default, type Output = Result<<St as TryStream>::Ok, <St as TryStream>::Error>;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
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
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::try_poll_next on Unpin
stream types. Read more
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]>,