Struct ShutdownSignal 

pub struct ShutdownSignal { /* private fields */ }

A signal that tracks whether shutdown has been requested.

Thread-safe via atomic operations. Can be shared across threads as Arc<ShutdownSignal>.

Implementations

impl ShutdownSignal

pub fn new() -> Self

Create a new untriggered signal.

pub fn is_triggered(&self) -> bool

Returns true if shutdown has been requested.

pub fn trigger(&self)

Trigger the shutdown signal.

pub fn install(&self, _drain_timeout: Duration)

Install a SIGINT/SIGTERM handler (Unix only). On non-Unix platforms, this is a no-op — callers must call trigger() manually.

pub fn wait_for_trigger(&self, timeout: Duration) -> bool

Wait until triggered or timeout elapses. Returns true if triggered, false if timed out.

Trait Implementations

impl Clone for ShutdownSignal

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 ShutdownSignal

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

Formats the value using the given formatter.

impl Default for ShutdownSignal

fn default() -> ShutdownSignal

Returns the “default value” for a type.