Struct Condvar

pub struct Condvar { /* private fields */ }

A condition variable. Condition variables allow for tasks to wait until a notification is received.

Examples

let pair = Arc::new((Mutex::new(false), Condvar::new()));
let pair2 = pair.clone();

spawn(async move {
    let (lock, cvar) = &*pair2;
    let mut started = lock.lock().await;
    *started = true;
    cvar.notify_one();
}).detach();

let (lock, cvar) = &*pair;
let mut started = lock.lock().await;
while !*started {
    started = cvar.wait(started).await;
}

Implementations

impl Condvar

pub const fn new() -> Self

Creates a new condition variable.

pub fn wait<'a, T>( &'a self, guard: MutexGuard<'a, T>, ) -> CondvarWaitFuture<'a, T>

Waits for a notification on the condition variable.

pub fn notify_one(&self)

Notify one task waiting on the condition variable.

pub fn notify_all(&self)

Notify all tasks waiting on the condition variable.

Trait Implementations

impl Debug for Condvar

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

Formats the value using the given formatter.

impl Default for Condvar

fn default() -> Self

Returns the “default value” for a type.