Struct async_wakers::Wakers

pub struct Wakers(_);

A container allowing task Wakers to register themselves to be notified later (eg. when data becomes available).

The registered wakers can be notified using one of two methods:

• notify_one notifies a waker that hasn't been notified recently (unless if it was updated after);
• notify_all notifies all the wakers that haven't been notified recently (unless if they were updated after).

Methods

impl Wakers

pub fn new() -> Self

Constructs a new, empty Wakers.

pub fn ready(&self) -> usize

Returns the number of wakers that are ready to be notified.

pub fn register(&self, waker: Waker) -> Registration

Registers a new Waker and returns a Registration handle to update and remove it.

pub fn unregister(&self, registration: Registration) -> Option<Waker>

Unregisters a waker using its Registration handle and returns it, or None if it has been notified recently (and not updated after) or if it has already been unregistered.

pub fn clear(&self)

Unregisters all wakers.

pub fn notify_one(&self) -> bool

Notifies a waker that hasn't been notified recently (unless if it was updated after) and returns whether one could be found and notified.

This method returns false if no waker has been registered or is ready (ie. if all wakers were recently notified and none were updated after).

pub fn notify_all(&self) -> usize

Notifies all registered wakers that haven`t been notified recently (unless if they were updated after) and returns the number of wakers that were notified.

This method returns 0 if no waker has been registered is ready (ie. if all wakers were recently notified and none were updated after).

Trait Implementations

impl Clone for Wakers

fn clone(&self) -> Wakers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wakers

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

Formats the value using the given formatter.

impl Default for Wakers

fn default() -> Wakers

Returns the "default value" for a type.