Struct futures_util::stream::SelectAll[][src]

#[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: Stream + Unpin> SelectAll<St>[src]

pub fn new() -> Self[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> Debug for SelectAll<St>[src]

impl<St: Stream + Unpin> Default for SelectAll<St>[src]

impl<St: Stream + Unpin> Extend<St> for SelectAll<St>[src]

impl<St: Stream + Unpin> FromIterator<St> for SelectAll<St>[src]

impl<St: Stream + Unpin> FusedStream for SelectAll<St>[src]

impl<St: Stream + Unpin> Stream for SelectAll<St>[src]

type Item = St::Item

Values yielded by the stream.

Auto Trait Implementations

impl<St> !RefUnwindSafe for SelectAll<St>

impl<St> Send for SelectAll<St> where
    St: Send

impl<St> Sync for SelectAll<St> where
    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]

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

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

impl<T> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future