Struct SpawnedTask 

pub struct SpawnedTask { /* private fields */ }

A single background task with cooperative cancellation.

Created by SpawnedTask::spawn, which hands the body a child CancellationToken to select! on. Stop it with shutdown (cancel → await up to a grace period → abort) so a wedged task can never block shutdown indefinitely. Extra teardown (closing connections, flushing buffers) stays with the caller.

Implementations

impl SpawnedTask

pub fn spawn<F, Fut>(body: F) -> Self

where F: FnOnce(CancellationToken) -> Fut, Fut: Future<Output = ()> + Send + 'static,

Spawn body with a fresh cancellation token passed to the closure.

The body should select! on token.cancelled() to exit promptly.

pub fn spawn_with<Fut>(cancel: CancellationToken, body: Fut) -> Self

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

Spawn body with the supplied cancellation token (e.g. a shared parent).

pub const fn from_parts( cancel: CancellationToken, handle: JoinHandle<()>, ) -> Self

Adopt an already-spawned JoinHandle paired with the token that stops it. For callers that spawn the task themselves but still want the bounded drain-then-abort shutdown.

pub fn cancel(&self)

Signal the task to stop without waiting for it to finish.

pub fn is_finished(&self) -> bool

Return true once the task has finished.

pub fn cancellation(&self) -> CancellationToken

A clone of the task’s cancellation token, for cooperative shutdown.

pub async fn shutdown(self, grace: Duration)

Cancel the task and wait up to grace for it to drain, aborting if it overruns. Always resolves; never blocks shutdown indefinitely.

pub fn abort(self)

Abort the task immediately without waiting.

pub async fn join(self)

Wait for the task to finish without cancelling it.

Trait Implementations

impl Debug for SpawnedTask

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

Formats the value using the given formatter.