Struct futures_util::stream::SelectAll
[−]
[src]
#[must_use = "streams do nothing unless polled"]pub struct SelectAll<S> { /* 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.
Methods
impl<S: Stream> SelectAll<S>
[src]
pub fn new() -> SelectAll<S>
[src]
Constructs a new, empty SelectAll
The returned SelectAll
does not contain any streams and, in this
state, SelectAll::poll
will return Ok(Async::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: S)
[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<T: Debug> Debug for SelectAll<T>
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl<S: Stream> Stream for SelectAll<S>
[src]
type Item = S::Item
Values yielded by the stream.
type Error = S::Error
Errors yielded by the stream.
fn poll_next(
&mut self,
cx: &mut Context
) -> Poll<Option<Self::Item>, Self::Error>
[src]
&mut self,
cx: &mut Context
) -> Poll<Option<Self::Item>, Self::Error>
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