Struct sync::condvar::Condvar

pub struct Condvar {
    std: Condvar,
}

A Condition Variable.

Fields

std: Condvar

Implementations

impl Condvar

pub const fn new() -> Condvar

Creates a new condvar that is ready to be waited on.

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

Waits on a condvar, blocking the current thread until it is notified.

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 wait_timeout<'a, T>( &self, guard: MutexGuard<'a, T>, dur: Duration ) -> (MutexGuard<'a, T>, WaitTimeoutResult)

Waits on a condvar, blocking the current thread until it is notified or the specified duration has elapsed.

pub fn wait_timeout_while<'a, T, F>( &self, guard: MutexGuard<'a, T>, dur: Duration, condition: F ) -> (MutexGuard<'a, T>, WaitTimeoutResult)

where F: FnMut(&mut T) -> bool,

Waits on this condition variable for a notification, timing out after a specified duration.

pub fn notify_one(&self)

Notifies one thread blocked by this condvar.

pub fn notify_all(&self)

Notifies all threads blocked by this condvar.

Trait Implementations

impl Debug for Condvar

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

Formats the value using the given formatter.

impl Default for Condvar

fn default() -> Condvar

Returns the “default value” for a type.