alloc::task::Wake - Rust
Description: API documentation for the Rust `Wake` trait in crate `alloc`.
Keywords: rust, rustlang, rust-lang, Wake

# [−][src]Trait alloc::task::Wake

    pub trait Wake: Send + Sync {
        fn wake(arc_self: &Arc<Self>);

        unsafe fn wake_local(arc_self: &Arc<Self>) { ... }
    }

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

futures in libcore are unstable

A way of waking up a specific task.

Any task executor must provide a way of signaling that a task it owns is ready to be `poll`ed again. Executors do so by implementing this trait.

## Required methods

### `fn wake(arc_self: &Arc<Self>)`

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

futures in libcore are unstable

Indicates that the associated task is ready to make progress and should be `poll`ed.

Executors generally maintain a queue of "ready" tasks; `wake` should place the associated task onto this queue.

Loading content...

## Provided methods

### `unsafe fn wake_local(arc_self: &Arc<Self>)`

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

futures in libcore are unstable

Indicates that the associated task is ready to make progress and should be `poll`ed. This function is like `wake`, but can only be called from the thread on which this `Wake` was created.

Executors generally maintain a queue of "ready" tasks; `wake_local` should place the associated task onto this queue.

Loading content...

## Implementors

Loading content...

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)