Crate async_task

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.

Structs

Builder

A builder that creates a new task.

FallibleTask

A spawned task with a fallible response.

Runnable

A handle to a runnable task.

ScheduleInfo

Extra scheduling information that can be passed to the scheduling function.

Task

A spawned task.

WithInfo

Pass a scheduling function with more scheduling information - a.k.a. ScheduleInfo.

Traits

Schedule

The trait for scheduling functions.

Functions

spawn

Creates a new task.

spawn_local

Creates a new thread-local task.

spawn_unchecked^⚠

Creates a new task without Send, Sync, and 'static bounds.