Struct sync_block::Condvar

pub struct Condvar<P = Spin>where
    P: DeadlockPrevention,{ /* private fields */ }

A condition variable.

Condition variables represent the ability to block a thread such that it consumes no CPU time while waiting for an event to occur.

Implementations

impl<P> Condvar<P>where P: DeadlockPrevention,

pub const fn new() -> Self

Returns a new condition variable.

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

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

Note that this function is susceptible to spurious wakeups. Condition variables normally have a boolean predicate associated with them, and the predicate must always be checked each time this function returns to protect against spurious wakeups.

pub fn wait_while<'a, T, F>( &self, guard: MutexGuard<'a, T>, condition: F ) -> MutexGuard<'a, T>where F: FnMut(&mut T) -> bool,

Blocks the current thread until this condition variable receives a notification and the provided condition is false.

pub fn notify_one(&self)

Wakes up one thread blocked on this condvar.

pub fn notify_all(&self)

Wakes up all threads blocked on this condvar.