Struct Condition 

pub struct Condition<T = ()> { /* private fields */ }

A condition that can wake several waiting tasks at once.

Notifications are not queued. A waiter must have been polled and registered its waker before notify is called, otherwise it misses that value. Use notify_and_lock when no later notifications should be accepted.

Implementations

impl<T> Condition<T>

pub fn new() -> Condition<T>

Creates an unlocked condition with no waiters.

impl<T: Clone> Condition<T>

pub fn wait(&self) -> Waiter<T>

Creates a new waiter.

The waiter starts listening when it is first polled, not when this method returns.

pub fn notify(&self, val: T)

Sends val to every waiter that is currently being polled.

The value is cloned for each registered waiter. Unpolled waiters do not receive it, and the value is not retained for future waiters.

pub fn notify_and_lock(&self, val: T)

Notifies the current waiters and permanently locks the condition.

Registered waiters receive val. Later readiness checks return ConditionResult::Locked, and later calls to notify do not deliver another value.

impl<T: Default> Condition<T>

pub fn notify_default(&self)

Sends T::default() to every waiter that is currently being polled.

Trait Implementations

impl<T> Clone for Condition<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Condition<T>

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

Formats the value using the given formatter.

impl Default for Condition<()>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for Condition<T>

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.