Struct AbortOnDrop 

pub struct AbortOnDrop<T: Send + 'static>(/* private fields */);

Calls Handle::abort when dropped.

Supervision ties spawned tasks to their spawning task’s lifetime, but work spawned from a plain future outlives that future’s drop. Wrapping the handle (see Handle::abort_on_drop) ties the task’s cancellation to the guard instead. Dropping the guard signals cancellation. Use AbortOnDrop::abort to also join the handle. Completion handles only stop waiting and do not cancel the underlying work (see Handle).

Implementations

impl<T: Send + 'static> AbortOnDrop<T>

pub async fn abort(self)

Abort and join the handle. Completion handles only stop waiting for the underlying work.

pub async fn join(self) -> Result<T, Error>

Join the handle.

impl<T, E1> AbortOnDrop<Result<T, E1>>

where T: Send + 'static, E1: Send + 'static,

pub fn join_all<E2>( guards: Vec<Self>, ) -> impl Future<Output = Result<Vec<T>, E2>>

where E2: From<E1> + From<Error>,

Join guards in order, collecting each task’s output.

On the first failure (a task error or a failed join), abort every remaining guard, discard collected outputs, and drain the remaining guards concurrently before surfacing the error. Joining in order makes the surfaced failure deterministic.

Spawned tasks are cancelled and joined. Completion handles only stop waiting for their underlying work.

Dropping the returned future signals every cancellation before destroying any owned outputs or completion futures.

Trait Implementations

impl<T: Send + 'static> Drop for AbortOnDrop<T>

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.