vibeio 0.2.8

A high-performance, cross-platform asynchronous runtime for Rust
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
28
29
30
31
32

//! Async signal utilities integrated with `vibeio`.
//!
//! This module provides cross-platform signal handling:
//! - `ctrl_c()` provides a future that resolves when Ctrl-C is received.
//! - On Unix, `Signal` and `signal()` allow listening for specific signals.
//!
//! # Examples
//! ```ignore
//! // Wait for Ctrl-C (cross-platform)
//! let _ = vibeio::signal::ctrl_c().await?;
//!
//! // Wait for SIGTERM (Unix only)
//! # #[cfg(unix)]
//! let mut sig = vibeio::signal::signal(vibeio::signal::SignalKind::terminate())?;
//! sig.recv().await?;
//! ```
//!
//! # Implementation notes
//! - On Unix, signals are delivered via a dedicated dispatch thread that reads
//!   from a pipe and wakes registered wakers.
//! - On Windows, Ctrl-C is handled via `SetConsoleCtrlHandler`.
//! - Multiple listeners can register for the same signal; all will be woken.

#[cfg(unix)]
mod unix;
#[cfg(windows)]
mod windows;

#[cfg(unix)]
pub use unix::{ctrl_c, signal, CtrlC, Signal, SignalKind};
#[cfg(windows)]
pub use windows::{ctrl_c, CtrlC};