Struct LocalTasks 

pub struct LocalTasks(LocalPool);

The async tasks a world runs, held as a component of that world.

Whoever drives the world pumps them, which is what LocalTasks::pump does, so a task lasts as long as the world rather than as long as the call that started it. A world holds at most one set.

Tuple Fields

0: LocalPool

Implementations

impl LocalTasks

pub fn new() -> Self

An empty task set.

pub fn install(world: &mut World)

Give world a task set, unless it already has one.

Every world the framework builds is given one this way at creation, before its setup runs, so the setup can spawn a task of its own.

pub fn pump(world: &mut World)

Drive world’s tasks until none can make progress.

Call this once per turn of whatever drives the world: a thread’s tick loop before the tick, a host’s frame before the dispatch. A world the caller made itself is given its task set here, so its tasks have an owner from its first pumped turn on.

A task that panics unwinds out of the pump and takes the caller’s turn with it, exactly as a panicking job or tick would.

pub fn spawn<F>(world: &World, future: F) -> bool

where F: Future<Output = ()> + 'static,

Hand future to the tasks world runs, answering whether it took it.

The task is polled from the world’s next pump on. A world with no task set answers false: the framework gives one to every world it builds, and LocalTasks::pump gives one to a world that lacks it.

Trait Implementations

impl Default for LocalTasks

fn default() -> Self

Returns the “default value” for a type.