Skip to main content

WaitCondition

Struct WaitCondition 

Source
pub struct WaitCondition<F>
where F: Fn() -> bool,
{ /* private fields */ }
Expand description

A named condition variable backed by a WaitQueue.

Stores a reusable condition closure alongside the queue. Multiple tasks can wait on the same WaitCondition; they are all woken when notify_all is called, and each re-checks the stored condition before returning.

Inspired by Theseus OS wait_condition crate. Wrap in an Arc to share across tasks.

§Example

static FLAG: AtomicBool = AtomicBool::new(false);
static COND: WaitCondition<_> = WaitCondition::new(|| FLAG.load(Ordering::Acquire));

// Waiter task:
COND.wait();

// Notifier task:
FLAG.store(true, Ordering::Release);
COND.notify_all();

Implementations§

Source§

impl<F: Fn() -> bool> WaitCondition<F>

Source

pub fn new(condition: F) -> Self

Create a new WaitCondition with the given condition function.

Source

pub fn wait(&self)

Block the current task until the stored condition returns true.

Returns immediately (without blocking) if the condition is already true. Spurious wakeups are impossible.

§Panics

Panics if called outside of a task context.

Source

pub fn notify_one(&self) -> bool

Wake one task waiting on this condition.

The woken task will re-check the condition before returning from wait. Returns true if a task was woken.

Source

pub fn notify_all(&self) -> usize

Wake all tasks waiting on this condition.

Each woken task will re-check the condition independently. Returns the number of tasks that were moved back to the ready queue.

Auto Trait Implementations§

§

impl<F> !Freeze for WaitCondition<F>

§

impl<F> !RefUnwindSafe for WaitCondition<F>

§

impl<F> Send for WaitCondition<F>
where F: Send,

§

impl<F> Sync for WaitCondition<F>
where F: Sync,

§

impl<F> Unpin for WaitCondition<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for WaitCondition<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for WaitCondition<F>
where F: UnwindSafe,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.