Struct TaskGroup

pub struct TaskGroup { /* private fields */ }

Allows the user to spawn multiple Tasks and await them as a unit.

Tasks can be added to this group using [TaskGroup::add]. All pending tasks in the group can be awaited using TaskGroup::join.

New code should prefer to use Scope instead.

Implementations

impl TaskGroup

pub fn new() -> Self

Creates a new TaskGroup.

The TaskGroup can be used to await an arbitrary number of Tasks and may consume an arbitrary amount of memory.

pub fn spawn(&mut self, future: impl Future<Output = ()> + Send + 'static)

Spawns a new task in this TaskGroup.

To add a future that is not Send to this TaskGroup, use TaskGroup::local.

Panics

spawn may panic if not called in the context of an executor (e.g. within a call to run or run_singlethreaded).

pub fn local(&mut self, future: impl Future<Output = ()> + 'static)

Spawns a new task in this TaskGroup.

Panics

spawn may panic if not called in the context of a single threaded executor (e.g. within a call to run_singlethreaded).

pub async fn join(self)

Waits for all Tasks in this TaskGroup to finish.

Call this only after all Tasks have been added.

Trait Implementations

impl Default for TaskGroup

fn default() -> Self

Returns the “default value” for a type.