Struct FlagBlock

pub struct FlagBlock { /* private fields */ }

A basic condition variable for async tasks. If you call wait() you get back a future that you can await on, which will complete once another tasks calls signal_all(). But there’s a gotcha here.

Okay so you know the rule with mutexes and condition variables? Like, you have some predicate that tells you “ready” or not, and this is tested with the mutex held, followed by waiting on the condition variable (which automatically releases and reaquires the lock).

We have something similar. You need to call wait() with that mutex held, and then after you release the lock, you call await on the future returned by wait().

Implementations

impl FlagBlock

pub fn new() -> Self

Construct a new FlagBlock.

pub fn signal_all(&self)

Signal anyone waiting.

pub fn wait(&self) -> FlagBlockFuture<'_>

Return an awaitable future for the “readiness” of this condition variable.

Trait Implementations

impl Default for FlagBlock

fn default() -> FlagBlock

Returns the “default value” for a type.