Struct unicycle::Unordered

pub struct Unordered<F> { /* fields omitted */ }

A container for an unordered collection of Futures.

Examples

use tokio::{stream::StreamExt as _, time};
use std::time::Duration;

#[tokio::main]
async fn main() {
    let mut futures = unicycle::Unordered::new();

    futures.push(time::delay_for(Duration::from_secs(2)));
    futures.push(time::delay_for(Duration::from_secs(3)));
    futures.push(time::delay_for(Duration::from_secs(1)));

    while let Some(_) = futures.next().await {
        println!("tick");
    }

    println!("done!");
}

Methods

impl<F> Unordered<F>

pub fn new() -> Self

Construct a new, empty Unordered.

Examples

use unicycle::Unordered;

let mut futures = Unordered::new();
assert!(futures.is_empty());

futures.push(async { 42 });

pub fn is_empty(&self) -> bool

Test if the collection of futures is empty.

Examples

use unicycle::Unordered;

let mut futures = Unordered::<tokio::time::Delay>::new();
assert!(futures.is_empty());

pub fn push(&mut self, future: F)

Add the given future to the Unordered stream.

Newly added futures are guaranteed to be polled, but there is no guarantee in which order this will happen.

Pushed tasks are pinned by the Unordered collection automatically.

Examples

use unicycle::Unordered;

let mut futures = Unordered::new();
assert!(futures.is_empty());
futures.push(async { 42 });
assert!(!futures.is_empty());

Trait Implementations

impl<F> Default for Unordered<F>

fn default() -> Self

Returns the "default value" for a type.

impl<F> Drop for Unordered<F>

fn drop(&mut self)

Executes the destructor for this type.

impl<F> Send for Unordered<F>

impl<F> Stream for Unordered<F> where
    F: Future, 

type Item = F::Output

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::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.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<F> Sync for Unordered<F>

impl<F> Unpin for Unordered<F>