Struct futures_util::task::WakerRef

pub struct WakerRef<'a> { /* fields omitted */ }

A Waker that is only valid for a given lifetime.

Note: this type implements Deref<Target = Waker>, so it can be used to get a &Waker.

Methods

impl<'a> WakerRef<'a>

pub fn new(waker: Waker) -> Self

Create a new WakerRef from a Waker.

Note: this function is safe, but it is generally only used from unsafe contexts that need to create a Waker that is guaranteed not to outlive a particular lifetime.

Methods from Deref<Target = 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 will_wake(&self, other: &Waker) -> bool

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

futures in libcore are unstable

Returns whether or not this Waker and other Waker have awaken 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.

Trait Implementations

impl<'a> Deref for WakerRef<'a>

type Target = Waker

The resulting type after dereferencing.

fn deref(&self) -> &Waker

Dereferences the value.

impl<'a> Debug for WakerRef<'a>

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

Formats the value using the given formatter.