Struct timely_util::operators_async_ext::Scheduler

pub struct Scheduler {
    inner: Rc<Cell<bool>>,
}

A helper type to integrate timely notifications with async futures. Its intended to be used with a top level while loop. Timely will automatically make the futures returned by scheduler.notified.await() resolve when there are progress or data updates to be processed by the operator

async fn example(s: Scheduler) {
    while scheduler.notified().await {
    }
}

Fields

inner: Rc<Cell<bool>>

Implementations

impl Scheduler

fn notify(&self) -> bool

Notifies a waiting task, returning a boolean indicating whether or not there was a pending notification already stored in the scheduler.

If a task is currently waiting, that task is notified. Otherwise, a permit is stored in this Scheduler and the next call to notified().await will complete immediately consuming the permit made available by this call to notify().

fn is_notified(&self) -> bool

Returns a boolean indicating whether a notification is pending

pub fn notified(&self) -> Notified<'_>

Wait for a notification.

Trait Implementations

impl Clone for Scheduler

fn clone(&self) -> Scheduler

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Scheduler

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Scheduler

fn default() -> Scheduler

Returns the “default value” for a type.