Struct async_shutdown::VitalToken

pub struct VitalToken { /* fields omitted */ }

Token that triggers a shutdown when it is dropped.

The token can be cloned and sent to different threads and tasks freely. If one of the cloned tokens is dropped, a shutdown is triggered. Even if the the rest of the clones still exist.

Implementations

impl VitalToken

pub fn wrap_vital<F: Future>(self, future: F) -> WrapVital<F>

Wrap a future to cause a shutdown when it completes or is dropped.

This consumes the token to avoid accidentally dropping the token after wrapping a future and instantly causing a shutdown. If you need to keep the token around, you can clone it first:

let future = vital_token.clone().wrap_future(future);

pub fn forget(self)

Drop the token without causing a shutdown.

This is equivalent to calling std::mem::forget() on the token.

Trait Implementations

impl Clone for VitalToken

fn clone(&self) -> VitalToken

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for VitalToken

fn drop(&mut self)

Executes the destructor for this type.