Enum Signal 

#[non_exhaustive]
pub enum Signal {
    Terminate,
    Interrupt,
    Quit,
    Hangup,
    Pipe,
    User1,
    User2,
}

A platform-neutral signal identifier.

Variants map to their nearest platform equivalent. On Unix the mapping is direct (SIGTERM, SIGINT, etc.). On Windows the mapping is to Windows console control events:

Variant	Unix	Windows
Terminate	SIGTERM	CTRL_CLOSE_EVENT
Interrupt	SIGINT	CTRL_C_EVENT
Quit	SIGQUIT	CTRL_BREAK_EVENT
Hangup	SIGHUP	CTRL_SHUTDOWN_EVENT
Pipe	SIGPIPE	inert
User1	SIGUSR1	inert
User2	SIGUSR2	inert

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Terminate

SIGTERM on Unix, CTRL_CLOSE_EVENT on Windows.

Interrupt

SIGINT (Ctrl+C) on Unix, CTRL_C_EVENT on Windows.

Quit

SIGQUIT on Unix, CTRL_BREAK_EVENT on Windows.

Hangup

SIGHUP on Unix, CTRL_SHUTDOWN_EVENT on Windows.

Pipe

SIGPIPE (Unix only; inert on Windows).

User1

SIGUSR1 (Unix only; inert on Windows).

User2

SIGUSR2 (Unix only; inert on Windows).

Implementations

impl Signal

pub const ALL: [Self; 7]

All defined variants, in canonical order.

pub const fn description(self) -> &'static str

Human-readable description used by Display and logging.

pub const fn unix_number(self) -> Option<i32>

Unix signal number for this variant. Returns None for variants that have no canonical Unix number (none currently, but the API reserves the right to add Windows-only variants).

pub const fn is_unix_only(self) -> bool

Returns true for variants that have no Windows analog.

pub const fn available_on_current_platform(self) -> bool

Returns true if installing a handler for this signal is expected to succeed on the platform this binary is running on.

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Signal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Signal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Signal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Signal

fn eq(&self, other: &Signal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Signal

impl Eq for Signal

impl StructuralPartialEq for Signal