Struct ConditionVariable 

pub struct ConditionVariable { /* private fields */ }

A condition variable for blocking threads until a condition becomes true.

Always used together with a Mutex: callers hold the mutex while checking the condition, then pass it to wait so the lock is released atomically while the thread sleeps.

Implementations

impl ConditionVariable

pub fn new() -> Self

Creates a new condition variable.

pub fn finalize(&self)

Destroys the condition variable. Called automatically on drop.

pub fn signal(&self)

Wakes one thread waiting on this condition variable.

pub fn broadcast(&self)

Wakes all threads waiting on this condition variable.

pub fn wait(&self, mutex: &Mutex)

Atomically releases mutex and blocks until signaled, then reacquires mutex.

pub fn wait_timeout( &self, mutex: &Mutex, timeout: Duration, ) -> ConditionVariableStatus

Like wait, but returns after at most timeout. Returns the wait status.

Trait Implementations

impl Drop for ConditionVariable

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.