Struct TaskGroup

pub struct TaskGroup { /* private fields */ }

A simple wrapper for TaskGroup that stores the TaskGroup in an Arc so it can be passed between threads.

Implementations

impl TaskGroup

pub fn new() -> Self

pub fn as_weak(&self) -> WeakTaskGroup

Creates a new WeakTaskGroup from this group.

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

Spawns a new task in this TaskGroup.

If join has been called on a clone of this TaskGroup, spawn will drop the task instead.

Panics

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

pub async fn join(self)

Waits for all Tasks in this TaskGroup to finish. Prevents future tasks from being spawned if there’s another task that holds a clone of this TaskGroup.

Trait Implementations

impl Clone for TaskGroup

fn clone(&self) -> TaskGroup

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.