Struct SignalKind

struct SignalKind(_)

Represents the specific kind of signal to listen for.

Implementations

impl SignalKind

const fn from_raw(signum: std::os::raw::c_int) -> Self

Allows for listening to any valid OS signal.

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

# use tokio::signal::unix::SignalKind;
# let signum = -1;
// let signum = libc::OS_SPECIFIC_SIGNAL;
let kind = SignalKind::from_raw(signum);
const fn as_raw_value(self: &Self) -> std::os::raw::c_int

Get the signal's numeric value.

# use tokio::signal::unix::SignalKind;
let kind = SignalKind::interrupt();
assert_eq!(kind.as_raw_value(), libc::SIGINT);
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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

impl Clone for SignalKind

fn clone(self: &Self) -> SignalKind

impl Copy for SignalKind

impl Debug for SignalKind

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

impl Eq for SignalKind

impl Freeze for SignalKind

impl From for SignalKind

fn from(signum: std::os::raw::c_int) -> Self

impl Hash for SignalKind

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

impl PartialEq for SignalKind

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

impl RefUnwindSafe for SignalKind

impl Send for SignalKind

impl StructuralPartialEq for SignalKind

impl Sync for SignalKind

impl Unpin for SignalKind

impl UnwindSafe for SignalKind

impl<T> Any for SignalKind

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for SignalKind

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for SignalKind

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> CloneToUninit for SignalKind

unsafe fn clone_to_uninit(self: &Self, dest: *mut u8)

impl<T> From for SignalKind

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for SignalKind

fn to_owned(self: &Self) -> T
fn clone_into(self: &Self, target: &mut T)

impl<T, U> Into for SignalKind

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for SignalKind

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for SignalKind

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>