Struct WaitQueue 

pub struct WaitQueue { /* private fields */ }

Available on crate feature threading only.

An WaitQueue, allowing threads to wait for or be notified by other threads.

Similar to [Event], but without any state.

Implementations

impl WaitQueue

pub const fn new() -> WaitQueue

Creates a new WaitQueue.

pub fn wait(&self)

Waits for this WaitQueue to be notified (blocking).

Panics

Panics if this is called outside of a thread context.

pub fn wait_until(&self, deadline: Instant) -> bool

Waits for this WaitQueue to be notified, with deadline (blocking).

Panics

Panics if this is called outside of a thread context.

pub fn wait_until_with_check( &self, deadline: Instant, check: impl Fn(CriticalSection<'_>) -> bool, ) -> bool

Waits for this WaitQueue to be notified, with deadline and check fn (blocking).

This function:

1. calls check()
2. if check() has returned true, returns true
3. else, waits on Self until deadline (or notification)
4. calls check() again, returns its result

Panics

Panics if this is called outside of a thread context.

pub fn notify_all(&self)

Notify all waiters.

pub fn notify_one(&self)

Notify one waiter.

Trait Implementations

impl Default for WaitQueue

fn default() -> WaitQueue

Returns the “default value” for a type.

impl Sync for WaitQueue