Struct TaskGroup

pub struct TaskGroup<S: Spawn, C: Deref<Target = State>> { /* private fields */ }

A group of potentially related tasks. Tasks spawned by this struct can be waited on or signaled to shut down.

Implementations

impl<S: Spawn> TaskGroup<S, Arc<State>>

pub fn new(spawner: S) -> Self

Create a new task group using the provided spawner

impl<S: Spawn> TaskGroup<S, &'static State>

pub fn with_static(spawner: S, state: &'static State) -> Self

Create a new task group using the provided spawner and state

impl<S: Spawn, C: 'static + Deref<Target = State> + Clone + Send> TaskGroup<S, C>

pub async fn shutdown(&self)

Signal a shutdown to all tasks in this group and wait for shutdown to finish.

pub async fn done(&self)

Wait for all tasks in this group to finish without explicitly sending a shutdown signal.

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

Spawn a task as part of this task group

pub fn spawn_with_shutdown<F>(&self, f: impl FnOnce(ShutdownSignal<C>) -> F)

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