[][src]Struct futures::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 contains a trait object pointing to an instance of the UnsafeWake trait, allowing notifications to get routed through it.

Methods

impl Waker
[src]

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

futures in libcore are unstable

Constructs a new Waker directly.

Note that most code will not need to call this. Implementers of the UnsafeWake trait will typically provide a wrapper that calls this but you otherwise shouldn't call it directly.

If you're working with the standard library then it's recommended to use the Waker::from function instead which works with the safe Arc type and the safe Wake trait.

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

futures in libcore are unstable

Wake up the task associated with this Waker.

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

futures in libcore are unstable

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

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

futures in libcore are unstable

Returns whether or not this Waker and other LocalWaker 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 From<LocalWaker> for Waker
[src]

Performs the conversion.

impl Debug for Waker
[src]

Formats the value using the given formatter. Read more

impl Drop for Waker
[src]

Executes the destructor for this type. Read more

impl Unpin for Waker
[src]

impl Sync for Waker
[src]

impl Send for Waker
[src]

impl Clone for Waker
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<T> From<Arc<T>> for Waker where
    T: Wake + 'static, 
[src]

Performs the conversion.

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

Creates owned data from borrowed data, usually by cloning. Read more

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

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

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

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.