Struct Condvar

pub struct Condvar { /* private fields */ }

A condition variable.

This type allows multiple tasks to wait for an action to be completed. This type is similar to [std::sync::Condvar], except that it is async and cross-platform, and cannot be spuriously woken.

Examples

use no_std_async::{Condvar, Mutex};

static CONDVAR: Condvar = Condvar::new();
static VALUE: Mutex<u8> = Mutex::new(0);

async fn task1() {
    for i in 0..10 {
        *VALUE.lock().await += 1; // some work
    }
    CONDVAR.notify_one(); // we're done!
}

async fn task2() {
    CONDVAR.wait().await; // wait for task1 to finish
    assert_eq!(10, *VALUE.lock().await);
}

Implementations

impl Condvar

pub const fn new() -> Self

Creates a new Condvar.

pub async fn wait(&self)

Blocks the current task until this condition variable receives a notification.

pub fn notify_one(&self)

Notifies a single task waiting on this condition variable.

pub fn notify_all(&self)

Notifies all tasks waiting on this condition variable.