Struct Shutdown

pub struct Shutdown {
    pub handle: Handle,
    pub grace_period: Option<Duration>,
}

Available on crate feature axum only.

Axum server shutdown coordinator.

Clones will retain the same coordination.

Fields

handle: Handle

Axum server handle.

Clones will retain the same coordination.

grace_period: Option<Duration>

Grace period. None means indefinite.

Implementations

impl Shutdown

pub fn new(grace_period: Option<Duration>) -> Self

Constructor.

pub fn shutdown(&self)

Shutdown (graceful).

pub fn shutdown_now(&self)

Shutdown now (ignore grace period).

pub fn cancellation_token(&self) -> (CancellationToken, JoinHandle<()>)

Get a CancellationToken.

Call CancellationToken::cancel to shutdown.

It’s best not to call this function more than once, as it spawns a listener task. If you need several tokens, clone the one you get here.

Also returns the JoinHandle for the listener task.

pub fn on_channel(&self) -> (Sender<()>, JoinHandle<()>)

Shutdown on channel send.

Call Sender::send to shutdown.

It’s best not to call this function more than once, as it spawns a listener task. If you need several senders, clone the one you get here.

Also returns the JoinHandle for the listener task.

pub fn on_signals(&self) -> Result<JoinHandle<()>>

Shutdown on signals.

Returns the JoinHandle for the listener task.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

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.