Struct TaskGroup 

pub struct TaskGroup { /* private fields */ }

Owns a related group of cancellation-aware live tasks, one generation at a time.

Call Self::finish_shutdown to observe task failures. Dropping the group requests forced cancellation but cannot asynchronously prove termination.

Implementations

impl TaskGroup

pub fn new() -> Self

Creates an open initial task generation.

pub fn spawner(&self) -> Result<TaskSpawner, TaskSpawnError>

Returns a capability bound to the current open generation.

Errors

Returns an error after shutdown begins.

pub fn cancellation_token(&self) -> CancellationToken

Returns a non-authoritative cancellation signal for the current generation.

pub fn spawn<F>(&self, future: F) -> Result<(), TaskSpawnError>

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

Registers future before allowing it to poll.

Errors

Returns an error after shutdown begins.

pub fn begin_shutdown(&self)

Closes admission and cancels the current generation.

pub fn abort(&self)

Closes admission and requests immediate forced cancellation.

pub async fn finish_shutdown( &self, graceful_timeout: Duration, abort_timeout: Duration, ) -> Result<(), TaskShutdownError>

Drains the closed generation within graceful and forced bounds.

Errors

Returns an error if admission is open, a task fails unexpectedly, or forced completion reaches its deadline. Timed-out tasks remain tracked and reopening stays disabled.

pub fn start_generation(&self) -> Result<(), TaskGenerationError>

Opens a fresh generation after the prior generation fully drains.

Errors

Returns an error while the current generation remains open or owns tasks.

pub fn is_empty(&self) -> bool

Returns whether no tasks remain owned.

pub fn all_finished(&self) -> bool

Returns whether every tracked task has finished.

pub fn is_open(&self) -> bool

Returns whether the current generation accepts tasks.

pub fn len(&self) -> usize

Returns the number of tasks currently owned.

Trait Implementations

impl Debug for TaskGroup

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

Formats the value using the given formatter.

impl Default for TaskGroup

fn default() -> Self

Returns the “default value” for a type.

impl Drop for TaskGroup

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.