Enum ShutdownReason 

#[non_exhaustive]
pub enum ShutdownReason {
    Signal(Signal),
    Requested,
    Forced,
    Timeout,
    Error,
}

Why a shutdown was initiated.

Carried by ShutdownTrigger::trigger and surfaced to observers via ShutdownToken::reason and to hooks via ShutdownHook::run.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Signal(Signal)

Originated from a delivered OS signal.

Requested

Programmatic shutdown request (admin endpoint, parent supervisor, fatal-error branch, etc.).

Forced

Graceful budget elapsed; remaining hooks were skipped.

Timeout

A timed operation exceeded its deadline.

Error

Shutdown driven by an internal error condition.

Implementations

impl ShutdownReason

pub const fn description(self) -> &'static str

Short human-readable label.

pub const fn is_signal(self) -> bool

true if this reason was caused by a signal.

Trait Implementations

impl Clone for ShutdownReason

fn clone(&self) -> ShutdownReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownReason

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

Formats the value using the given formatter.

impl Display for ShutdownReason

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

Formats the value using the given formatter.

impl PartialEq for ShutdownReason

fn eq(&self, other: &ShutdownReason) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ShutdownReason

impl Eq for ShutdownReason

impl StructuralPartialEq for ShutdownReason