Bug: 180427432

Clone this repo:
  1. 3ef2df7 Migrate 25 crates to monorepo am: 656da64d57 by James Farrell · 5 months ago main master
  2. 656da64 Migrate 25 crates to monorepo by James Farrell · 5 months ago main-16k
  3. ba3e9e5 Generate license header with cargo_embargo. am: 9e51ef33b6 by Andrew Walbran · 6 months ago
  4. 9e51ef3 Generate license header with cargo_embargo. by Andrew Walbran · 6 months ago
  5. b7699de Cleanup license metadata in external/rust/crates/async-task. am: 4ee9c3937b by Wei Li · 6 months ago

async-task

Build License Cargo Documentation

Task abstraction for building executors.

To spawn a future onto an executor, we first need to allocate it on the heap and keep some state attached to it. The state indicates whether the future is ready for polling, waiting to be woken up, or completed. Such a stateful future is called a task.

All executors have a queue that holds scheduled tasks:

let (sender, receiver) = flume::unbounded();

A task is created using either spawn(), spawn_local(), or spawn_unchecked() which return a Runnable and a Task:

// A future that will be spawned.
let future = async { 1 + 2 };

// A function that schedules the task when it gets woken up.
let schedule = move |runnable| sender.send(runnable).unwrap();

// Construct a task.
let (runnable, task) = async_task::spawn(future, schedule);

// Push the task into the queue by invoking its schedule function.
runnable.schedule();

The Runnable is used to poll the task's future, and the Task is used to await its output.

Finally, we need a loop that takes scheduled tasks from the queue and runs them:

for runnable in receiver {
    runnable.run();
}

Method run() polls the task's future once. Then, the Runnable vanishes and only reappears when its Waker wakes the task, thus scheduling it to be run again.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.