Struct tokio_shutdown::Shutdown

pub struct Shutdown { /* private fields */ }

The global shutdown handler for an application. It can be cloned cheaply wherever needed.

New handles can be created with the handle function, which creates futures that will complete once a shutdown signal is received.

Implementations

impl Shutdown

pub fn new() -> Result<Shutdown, AlreadyCreatedError>

Create a new shutdown handle. This can only be called once per application instance.

Signal handles can only be registered once for the duration of the entire process and creating another shutdown handler would break the previous one without notice.

Errors

If this function is called more than once during the lifetime of a process, an error will be returned.

pub fn handle(&self) -> impl Future<Output = ()>

Create a new handle that can be awaited on. The future will complete once a shutdown signal is received.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

Returns a copy of the value.

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

Performs copy-assignment from source.