Struct ConditionGuard 

pub struct ConditionGuard<'a, T>(/* private fields */);

Guard returned by lock.

Implementations

impl<'a, T> ConditionGuard<'a, T>

pub fn add_waker(&mut self, waker_entry: Pin<&mut WakerEntry<T>>, waker: Waker)

Adds the waker entry to the condition’s list of wakers.

Panics

This will panic if the waker entry is associated with a different Condition.

pub fn drain_wakers<'b>(&'b mut self) -> Drainer<'b, 'a, T>

Returns an iterator that will drain all wakers. Whilst the drainer exists, a lock is held which will prevent new wakers from being added to the list, so depending on your use case, you might wish to collect the wakers before calling wake on each waker. NOTE: If the drainer is dropped, this will not drain elements not visited.

pub fn waker_count(&self) -> usize

Returns the number of wakers registered with the condition.

pub fn block_until(&mut self, condition: impl FnMut(&mut Self) -> bool)

Blocks the current thread until condition returns true.

The mutex is unlocked while waiting and re-locked before this function returns.

Trait Implementations

impl<T> Deref for ConditionGuard<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for ConditionGuard<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.