Struct futures::task::Waker

#[repr(transparent)]
pub struct Waker { /* private fields */ }

A Waker is a handle for waking up a task by notifying its executor that it is ready to be run.

This handle encapsulates a RawWaker instance, which defines the executor-specific wakeup behavior.

Implements Clone, Send, and Sync.

Implementations

impl Waker

pub fn wake(self)

Wake up the task associated with this Waker.

pub fn wake_by_ref(&self)

Wake up the task associated with this Waker without consuming the Waker.

This is similar to wake, but may be slightly less efficient in the case where an owned Waker is available. This method should be preferred to calling waker.clone().wake().

pub fn will_wake(&self, other: &Waker) -> bool

Returns true if this Waker and another Waker have awoken the same task.

This function works on a best-effort basis, and may return false even when the Wakers would awaken the same task. However, if this function returns true, it is guaranteed that the Wakers will awaken the same task.

This function is primarily used for optimization purposes.

pub unsafe fn from_raw(waker: RawWaker) -> Waker

Creates a new Waker from RawWaker.

The behavior of the returned Waker is undefined if the contract defined in RawWaker’s and RawWakerVTable’s documentation is not upheld. Therefore this method is unsafe.

pub fn as_raw(&self) -> &RawWaker

🔬 This is a nightly-only experimental API. (waker_getters)

Get a reference to the underlying RawWaker.

Trait Implementations

impl Clone for Waker

pub fn clone(&self) -> Waker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Waker

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

Formats the value using the given formatter.

impl Drop for Waker

pub fn drop(&mut self)

Executes the destructor for this type.

impl<W> From<Arc<W>> for Waker where
    W: 'static + Wake + Send + Sync, 

pub fn from(waker: Arc<W>) -> Waker

Use a Wake-able type as a Waker.

No heap allocations or atomic operations are used for this conversion.

impl Send for Waker

impl Sync for Waker

impl Unpin for Waker