signal-mod 1.0.0

Cross-platform OS signal handling and graceful-shutdown orchestration for Rust. One API for SIGTERM, SIGINT, SIGHUP, SIGQUIT, SIGPIPE, SIGUSR1, SIGUSR2 and the Windows console control events, with cloneable observer and initiator handles, priority-ordered shutdown hooks, and optional adapters for the Tokio and async-std runtimes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Back-end signal-handler installers.
//!
//! This module routes [`Coordinator::install`](crate::Coordinator::install)
//! to the right back-end at compile time, based on the active Cargo
//! features:
//!
//! | Feature           | Back-end                                           |
//! | ----------------- | -------------------------------------------------- |
//! | `tokio`           | [`tokio_rt`] - `tokio::signal` + `tokio::spawn`.   |
//! | `async-std`       | [`async_std_rt`] - `signal-hook-async-std` + ctrlc.|
//! | `ctrlc-fallback`  | [`ctrlc_sync`] - synchronous `ctrlc::set_handler`. |
//! | none of the above | [`Coordinator::install`] returns `Error::NoRuntime`. |
//!
//! `tokio` takes precedence over `async-std` when both are enabled.

#[cfg(feature = "tokio")]
pub(crate) mod tokio_rt;

#[cfg(all(feature = "async-std", not(feature = "tokio")))]
pub(crate) mod async_std_rt;

#[cfg(all(
    feature = "ctrlc-fallback",
    not(feature = "tokio"),
    not(feature = "async-std")
))]
pub(crate) mod ctrlc_sync;