Struct Waiter

pub struct Waiter {
    waker: Arc<Waker>,
}

A waiter that can put the current thread to sleep until it is woken up by the associated Waker.

By definition, a waiter belongs to the current thread, so it cannot be sent to another thread and its reference cannot be shared between threads.

Fields

waker: Arc<Waker>

Implementations

impl Waiter

pub fn new_pair() -> (Self, Arc<Waker>)

Creates a waiter and its associated Waker.

pub fn wait(&self)

Waits until the waiter is woken up by calling Waker::wake_up on the associated Waker.

This method returns immediately if the waiter has been woken since the end of the last call to this method (or since the waiter was created, if this method has not been called before). Otherwise, it puts the current thread to sleep until the waiter is woken up.

pub fn wait_until_or_cancelled<F, R, FCancel, E>( &self, cond: F, cancel_cond: FCancel, ) -> Result<R, E>

where F: FnMut() -> Option<R>, FCancel: Fn() -> Result<(), E>,

Waits until some condition is met or the cancel condition becomes true.

This method will return Ok(_) if the condition returns Some(_), and will stop waiting if the cancel condition returns Err(_). In this situation, this method will return the Err(_) generated by the cancel condition.

pub fn waker(&self) -> Arc<Waker>

Gets the associated Waker of the current waiter.

pub fn task(&self) -> &Arc<Task>

Returns the task that the associated waker will attempt to wake up.

Trait Implementations

impl Drop for Waiter

fn drop(&mut self)

Executes the destructor for this type.

impl !Send for Waiter

impl !Sync for Waiter