Struct WakerRegistration

pub struct WakerRegistration { /* private fields */ }

Utility struct to register and wake a waker. If a waker is registered, registering another waker will replace the previous one. The previous waker will be woken in this case, giving it a chance to reregister itself. Although it is possible to wake multiple tasks this way, this will cause them to wake each other in a loop registering themselves.

Implementations

impl WakerRegistration

pub const fn new() -> Self

Create a new WakerRegistration.

pub fn register(&mut self, w: &Waker)

Register a waker. Overwrites the previous waker, if any.

pub fn wake(&mut self)

Wake the registered waker, if any.

pub fn occupied(&self) -> bool

Returns true if a waker is currently registered

Trait Implementations

impl Debug for WakerRegistration

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

Formats the value using the given formatter.

impl Default for WakerRegistration

fn default() -> WakerRegistration

Returns the “default value” for a type.