Struct TaskGroup 

pub struct TaskGroup {
    tasks: Vec<TaskHandle>,
}

A group of background tasks that can be shut down together.

Use TaskGroup to spawn related background tasks and ensure they all shut down gracefully with a timeout.

Fields

tasks: Vec<TaskHandle>

Implementations

impl TaskGroup

pub fn new() -> Self

Create a new empty task group.

pub fn spawn<F>(&mut self, name: &'static str, fut: F)

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

Spawn a new task and add it to the group.

The task should respect shutdown signals (e.g., via tokio::select! on a shutdown receiver) to allow graceful termination.

Arguments

• name - A static name for the task (used in error messages)
• fut - The future to spawn

pub async fn join_all(self, timeout: Duration) -> Result<()>

Wait for all tasks to complete with a timeout.

Returns Ok(()) if all tasks complete successfully within the timeout. Returns Err if any task times out, panics, or returns an error.

Note: Tasks are joined sequentially. Each task gets the full timeout duration, so the total wait time may exceed the timeout if multiple tasks are slow. Also note that timed-out tasks continue running in the background - the timeout means “gave up waiting” not “task was stopped”.

pub async fn shutdown_and_join( self, shutdown: &Shutdown, timeout: Duration, ) -> Result<()>

Trigger shutdown and wait for all tasks to complete.

This is a convenience method that calls shutdown.trigger() and then waits for all tasks to complete with the given timeout.

pub fn len(&self) -> usize

Get the number of tasks in the group.

pub fn is_empty(&self) -> bool

Check if the group is empty.

Trait Implementations

impl Default for TaskGroup

fn default() -> Self

Returns the “default value” for a type.

impl TaskGroupExt for TaskGroup

fn spawn_task<T: BackgroundTask>(&mut self, task: T, shutdown: Shutdown)

Spawn a BackgroundTask into this group.