Struct diatomic_waker::WakeSink

pub struct WakeSink { /* private fields */ }

Available on crate feature alloc only.

An owned object that can await notifications from one or several WakeSources.

See the crate-level documentation for usage.

Implementations

impl WakeSink

pub fn new() -> Self

Creates a new sink.

pub fn source(&self) -> WakeSource

Creates an owned source.

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

Registers a new waker.

Registration is lazy: the waker is cloned only if it differs from the last registered waker (note that the last registered waker is cached even if it was unregistered).

pub fn unregister(&mut self)

Unregisters the waker.

After the waker is unregistered, subsequent calls to WakeSource::notify will be ignored.

Note that the previously-registered waker (if any) remains cached.

pub fn wait_until<P, T>(&mut self, predicate: P) -> WaitUntil<'_, P, T>

where P: FnMut() -> Option<T>,

Returns a future that can be awaited until the provided predicate returns a value.

The predicate is checked each time a notification is received.

Trait Implementations

impl Debug for WakeSink

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

Formats the value using the given formatter.

impl Default for WakeSink

fn default() -> WakeSink

Returns the “default value” for a type.