Struct ShutdownHandle 

pub struct ShutdownHandle { /* private fields */ }

External handle for the event loop to check shutdown status.

Shares the same AtomicBool as the world’s shutdown flag. Obtained via World::shutdown_handle.

Implementations

impl ShutdownHandle

pub fn is_shutdown(&self) -> bool

Returns true if shutdown has been triggered.

pub fn shutdown(&self)

Trigger shutdown from outside the event loop.

pub fn enable_signals(&self) -> Result<()>

Register SIGINT and SIGTERM handlers that trigger shutdown.

Unix/Linux only. Uses signal_hook::flag::register — the signal handler simply flips the shared AtomicBool. Safe to call multiple times (subsequent calls are no-ops at the OS level for the same signal).

Errors

Returns an error if the OS rejects the signal registration.

Platform Support

Targets Linux infrastructure. Not supported on Windows.