Struct async_wakers::Registration

pub struct Registration { /* fields omitted */ }

A handle for updating or removing a registered Waker from a Wakers container.

This handle is returned by the register method and contains a weak reference to a Wakers (this means that, while a Registration still exists, the Wakers it is referencing could have already been destroyed; similarly, a Registration could represent a waker that has been unregistered).

Methods

impl Registration

pub fn is_registered(&self) -> bool

Returns whether the waker is still registered.

This method will return false if remove has been called or if Wakers unregistered the waker either because unregister or clear was called or because it was destroyed.

pub fn update(&mut self, waker: Waker) -> Option<Waker>

Update the registered waker and returns the old Waker, or None if it has been notified recently (and not updated after) or if it has already been unregistered.

pub fn remove(&mut self) -> Option<Waker>

Unregisters the Waker and returns it, or None if it has been notified recently (and not updated after) or if it has already been unregistered.

Trait Implementations

impl Debug for Registration

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

Formats the value using the given formatter.

impl Drop for Registration

fn drop(&mut self)

Executes the destructor for this type.