Struct ShutdownSignal 

pub struct ShutdownSignal {
    receiver: Receiver<()>,
    _sender_anchor: Option<Sender<()>>,
    stopped: AtomicBool,
}

Signal for coordinating graceful shutdown of background tasks.

Tasks should periodically check should_stop or use wait to interrupt sleep when shutdown is requested.

Fields

receiver: Receiver<()>

_sender_anchor: Option<Sender<()>>

Keeps the sender alive when no external owner exists, preventing spurious Disconnected errors in wait().

stopped: AtomicBool

Implementations

impl ShutdownSignal

fn new(receiver: Receiver<()>) -> Self

pub fn never() -> Self

Creates a shutdown signal that never fires.

Intended for use in tests and one-shot contexts where graceful shutdown is not needed.

pub fn should_stop(&self) -> bool

Returns true if shutdown has been requested.

Once true is returned, all subsequent calls also return true (the shutdown state is latched). This is non-blocking and suitable for polling in tight loops.

pub fn wait(&self, duration: Duration) -> bool

Waits for the given duration or until shutdown is requested.

Returns true if shutdown was requested, false if the duration elapsed.

This is the preferred method for tasks that sleep between work cycles.