Struct ShutdownSignal 

pub struct ShutdownSignal { /* private fields */ }

A lightweight, clone-able handle for checking or awaiting shutdown.

Multiple kernels and background tasks can each hold a clone. Checking is_shutdown_requested is a single atomic load and therefore safe to call on hot paths.

Implementations

impl ShutdownSignal

pub fn is_shutdown_requested(&self) -> bool

Returns true once shutdown has been requested.

This is a single atomic load and can be called on hot paths without any overhead.

pub async fn wait(&self)

Wait until a shutdown signal is received.

This future completes as soon as any signal (SIGTERM, SIGINT, or a manual trigger) fires. It is cancel-safe.

Trait Implementations

impl Clone for ShutdownSignal

fn clone(&self) -> ShutdownSignal

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.