Struct Shutdown

pub struct Shutdown { /* private fields */ }

The Shutdown struct is the main entry point to the shutdown system.

It is created by calling Shutdown::new, which takes a Future that will be awaited on when shutdown is requested. Most users will want to create a Shutdown with Shutdown::default, which uses the default signal handler to trigger shutdown. See default_signal for more info.

(NOTE: that these defaults are not available when compiling with –cfg loom)

See the README for more info on how to use this crate.

Implementations

impl Shutdown

pub fn builder() -> ShutdownBuilder<WithSignal<Default>>

Create a ShutdownBuilder allowing you to add a delay, a custom shutdown trigger signal and even an overwrite signal to force a shutdown even if workers are still busy.

pub fn new(signal: impl Future + Send + 'static) -> Shutdown

Creates a new Shutdown struct with the given Future.

The Future will be awaited on when shutdown is requested.

pub fn no_signal() -> Shutdown

Creates a new Shutdown struct with no signal.

This is useful if you want to support a Waitgroup like system where you wish to wait for all open tasks without requiring a signal to be triggered first.

pub fn guard(&self) -> ShutdownGuard

Returns a ShutdownGuard which primary use is to prevent the Shutdown from shutting down.

The creation of a ShutdownGuard is lockfree.

pub fn guard_weak(&self) -> WeakShutdownGuard

Returns a WeakShutdownGuard which in contrast to ShutdownGuard does not prevent the Shutdown from shutting down.

Instead it is used to wait for “shutdown signal” to be triggered or to create a ShutdownGuard which prevents the Shutdown once and only once it is needed.

The creation of a WeakShutdownGuard is lockfree.

pub fn spawn_task<T>(&self, task: T) -> JoinHandle<<T as Future>::Output>

where T: Future + Send + 'static, <T as Future>::Output: Send + 'static,

Returns a Tokio [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task to complete. See [crate::sync::spawn] for more information.

pub fn spawn_task_fn<T, F>(&self, task: F) -> JoinHandle<<T as Future>::Output>

where T: Future + Send + 'static, <T as Future>::Output: Send + 'static, F: FnOnce(ShutdownGuard) -> T + Send + 'static,

Returns a Tokio [crate::sync::JoinHandle] that can be awaited on to wait for the spawned task (fn) to complete. See [crate::sync::spawn] for more information.

pub async fn shutdown(self) -> Duration

Returns a future that completes once the Shutdown has been triggered and all ShutdownGuards have been dropped.

The resolved Duration is the time it took for the Shutdown to to wait for all ShutdownGuards to be dropped.

You can use Shutdown::shutdown_with_limit to limit the time the Shutdown waits for all ShutdownGuards to be dropped.

Panics

This method can panic if the internal mutex is poisoned.

pub async fn shutdown_with_limit( self, limit: Duration, ) -> Result<Duration, TimeoutError>

Returns a future that completes once the Shutdown has been triggered and all ShutdownGuards have been dropped or the given Duration has elapsed.

The resolved Duration is the time it took for the Shutdown to to wait for all ShutdownGuards to be dropped.

You can use Shutdown::shutdown to wait for all ShutdownGuards to be dropped without a time limit.

Panics

This method can panic if the internal mutex is poisoned.

Trait Implementations

impl Default for Shutdown

fn default() -> Shutdown

Returns the “default value” for a type.