Struct BackgroundTasks 

pub struct BackgroundTasks { /* private fields */ }

Shutdown-aware collection of spawned background workers.

Implementations

impl BackgroundTasks

pub fn new() -> Self

Creates a task collection with a fresh shutdown token and the default shutdown grace.

pub fn with_shutdown_token(shutdown_token: CancellationToken) -> Self

Creates a task collection using an externally owned shutdown token.

pub fn with_shutdown_token_and_grace( shutdown_token: CancellationToken, shutdown_grace: Duration, ) -> Self

Creates a task collection using an externally owned token and custom shutdown grace.

pub fn shutdown_token(&self) -> CancellationToken

Returns a clone of the shutdown token observed by all workers in this collection.

pub fn push<F>(&mut self, task: F)

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

Spawns a worker into the collection.

pub async fn shutdown(self)

Requests shutdown, waits for cooperative exit, and aborts remaining workers after grace.

Trait Implementations

impl Default for BackgroundTasks

fn default() -> Self

Returns the “default value” for a type.