Struct async_shutdown::DelayShutdownToken

pub struct DelayShutdownToken<T: Clone> { /* private fields */ }

Token that delays shutdown completion as long as it exists.

The token can be cloned and sent to different threads and tasks freely.

All clones must be dropped before the shutdown can complete.

Implementations

impl<T: Clone> DelayShutdownToken<T>

pub fn wrap_future<F: Future>(self, future: F) -> WrapDelayShutdown<T, F>

Wrap a future to delay shutdown completion until the wrapped future completes or until it is dropped.

This consumes the token to avoid keeping an unused token around by accident, which would delay shutdown indefinitely. If you wish to use the token multiple times, you can clone it first:

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

The returned future transparently completes with the value of the wrapped future. However, the shutdown will not be considered complete until the future completes or is dropped.

Trait Implementations

impl<T: Clone> Clone for DelayShutdownToken<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone> Drop for DelayShutdownToken<T>

fn drop(&mut self)

Executes the destructor for this type.