Struct futures_core::task::Waker

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

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

futures in libcore are unstable

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.

Methods

impl Waker

pub fn wake(self)

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

futures in libcore are unstable

Wake up the task associated with this Waker.

pub fn wake_by_ref(&self)

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

futures in libcore are unstable

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

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

futures in libcore are unstable

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

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

futures in libcore are unstable

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.

Trait Implementations

impl Debug for Waker

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

Formats the value using the given formatter.

impl Drop for Waker

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Waker

fn clone(&self) -> Waker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Unpin for Waker

impl Sync for Waker

impl Send for Waker