Struct Shutdown 

pub struct Shutdown { /* private fields */ }

A cloneable handle that resolves when the process should stop.

One listener, many holders — which is what lets a binary run several servers and drain them together.

Implementations

impl Shutdown

pub fn manual() -> Self

A handle fired by hand, for tests and custom signal handling.

pub fn listen() -> Self

A handle wired to this platform’s termination signals: SIGTERM, SIGINT and SIGQUIT on unix, ctrl-c elsewhere.

The first signal starts the drain; a second exits immediately. Must be called from inside a Tokio runtime.

pub fn trigger(&self)

Starts the drain.

pub fn is_shutting_down(&self) -> bool

Whether the drain has started.

pub async fn recv(self)

Resolves when the drain starts, immediately if it already has.

Consumes the handle so the future is 'static; clone first if the handle is still needed.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shutdown

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.