Struct tokio::signal::unix::SignalKind

pub struct SignalKind(_);

Available on Unix and crate feature signal only.

Represents the specific kind of signal to listen for.

Implementations

impl SignalKind

pub const fn from_raw(signum: c_int) -> Self

Allows for listening to any valid OS signal.

For example, this can be used for listening for platform-specific signals.

// let signum = libc::OS_SPECIFIC_SIGNAL;
let kind = SignalKind::from_raw(signum);

pub const fn as_raw_value(&self) -> c_int

Get the signal’s numeric value.

let kind = SignalKind::interrupt();
assert_eq!(kind.as_raw_value(), libc::SIGINT);

pub const fn alarm() -> Self

Represents the SIGALRM signal.

On Unix systems this signal is sent when a real-time timer has expired. By default, the process is terminated by this signal.

pub const fn child() -> Self

Represents the SIGCHLD signal.

On Unix systems this signal is sent when the status of a child process has changed. By default, this signal is ignored.

pub const fn hangup() -> Self

Represents the SIGHUP signal.

On Unix systems this signal is sent when the terminal is disconnected. By default, the process is terminated by this signal.

pub const fn info() -> Self

Represents the SIGINFO signal.

On Unix systems this signal is sent to request a status update from the process. By default, this signal is ignored.

pub const fn interrupt() -> Self

Represents the SIGINT signal.

On Unix systems this signal is sent to interrupt a program. By default, the process is terminated by this signal.

pub const fn io() -> Self

Represents the SIGIO signal.

On Unix systems this signal is sent when I/O operations are possible on some file descriptor. By default, this signal is ignored.

pub const fn pipe() -> Self

Represents the SIGPIPE signal.

On Unix systems this signal is sent when the process attempts to write to a pipe which has no reader. By default, the process is terminated by this signal.

pub const fn quit() -> Self

Represents the SIGQUIT signal.

On Unix systems this signal is sent to issue a shutdown of the process, after which the OS will dump the process core. By default, the process is terminated by this signal.

pub const fn terminate() -> Self

Represents the SIGTERM signal.

On Unix systems this signal is sent to issue a shutdown of the process. By default, the process is terminated by this signal.

pub const fn user_defined1() -> Self

Represents the SIGUSR1 signal.

On Unix systems this is a user defined signal. By default, the process is terminated by this signal.

pub const fn user_defined2() -> Self

Represents the SIGUSR2 signal.

On Unix systems this is a user defined signal. By default, the process is terminated by this signal.

pub const fn window_change() -> Self

Represents the SIGWINCH signal.

On Unix systems this signal is sent when the terminal window is resized. By default, this signal is ignored.

Trait Implementations

impl Clone for SignalKind

fn clone(&self) -> SignalKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignalKind

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

Formats the value using the given formatter.

impl From<SignalKind> for c_int

fn from(kind: SignalKind) -> Self

Converts to this type from the input type.

impl From<i32> for SignalKind

fn from(signum: c_int) -> Self

Converts to this type from the input type.

impl Hash for SignalKind

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<SignalKind> for SignalKind

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SignalKind

impl Eq for SignalKind

impl StructuralEq for SignalKind

impl StructuralPartialEq for SignalKind