Struct futures_util::task::LocalWakerRef

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

A LocalWaker that is only valid for a given lifetime.

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

Methods

impl<'a> LocalWakerRef<'a>

pub fn new(local_waker: LocalWaker) -> Self

Create a new LocalWakerRef from a LocalWaker.

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

Methods from Deref<Target = LocalWaker>

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 LocalWaker.

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

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

futures in libcore are unstable

Returns whether or not this LocalWaker and other LocalWaker awaken the same task.

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

This function is primarily used for optimization purposes.

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

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

futures in libcore are unstable

Returns whether or not this LocalWaker and other Waker 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 LocalWakers will awaken the same task.

This function is primarily used for optimization purposes.

Trait Implementations

impl<'a> Debug for LocalWakerRef<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for LocalWakerRef<'a>

type Target = LocalWaker

The resulting type after dereferencing.

fn deref(&self) -> &LocalWaker

Dereferences the value.