Struct Gate 

pub struct Gate { /* private fields */ }

Park until a predicate holds.

wait_until re-runs check each time the gate is notified and resolves with the first Some it produces. The enable-before-check ordering is internal, so a notify racing the check is never lost.

Implementations

impl Gate

pub fn new() -> Self

Create a gate.

pub fn notify(&self)

Wake all parked waiters so they re-run their predicates.

Call after every state change a waiter might be watching.

pub async fn wait_until<T>(&self, check: impl FnMut() -> Option<T>) -> T

Park until check returns Some.

pub async fn wait_until_cancellable<T>( &self, token: &CancelToken, check: impl FnMut() -> Option<T>, ) -> Result<T, Cancelled>

Park until check returns Some or the token is cancelled.

Trait Implementations

impl Default for Gate

fn default() -> Gate

Returns the “default value” for a type.