Condition

Struct Condition 

Source
pub struct Condition { /* private fields */ }
Expand description

This is a Condition Variable similar to that provided by POSIX. As for POSIX condition variables, this assumes that a mutex is properly used to coordinate behaviour. In other terms there should not be race condition on notify_one or notify_all.

Implementations§

Source§

impl Condition

Source

pub fn new() -> Condition

Creates a new condition variable with a given capacity. The capacity indicates the maximum number of tasks that may be waiting on the condition.

Source

pub async fn wait<T>(&self, guard: AsyncMutexGuard<'_, T>)

Waits for the condition to be notified

Source

pub fn waiter<T>(&self, guard: MutexGuard<'_, T>) -> ConditionWaiter

Source

pub fn notify_one(&self)

Notifies one pending listener

Source

pub fn notify_all(&self)

Notifies all pending listeners

Trait Implementations§

Source§

impl Default for Condition

Source§

fn default() -> Condition

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.