Struct Signal 

pub struct Signal(/* private fields */);

Available on crate feature io_uring only.

A signal number for use with kill_process, kill_process_group, and kill_current_process_group.

For additional constructors such as Signal::rt_min (aka libc::SIGRTMIN), Signal::rt_max (aka libc::SIGRTMAX), Signal::rt (aka |n| libc::SIGRTMIN() + n), Signal::from_raw, and Signal::from_raw_nonzero, see rustix-libc-wrappers.

References

• POSIX
• Linux
• glibc

Implementations

impl Signal

pub const HUP: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGHUP

pub const INT: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGINT

pub const QUIT: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGQUIT

pub const ILL: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGILL

pub const TRAP: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGTRAP

pub const ABORT: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGABRT, aka SIGIOT

pub const BUS: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGBUS

pub const FPE: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGFPE

pub const KILL: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGKILL

pub const USR1: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGUSR1

pub const SEGV: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGSEGV

pub const USR2: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGUSR2

pub const PIPE: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGPIPE

pub const ALARM: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGALRM

pub const TERM: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGTERM

pub const STKFLT: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and neither bsd, nor solarish, nor target_os=aix, nor Cygwin, nor Haiku, nor target_os=horizon, nor target_os=hurd, nor target_os=nto, nor target_os=vita, nor linux_kernel and (MIPS or MIPS Release 6 or MIPS-64 or MIPS-64 Release 6 or target_arch=sparc or SPARC64) only.

SIGSTKFLT

pub const CHILD: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGCHLD

pub const CONT: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGCONT

pub const STOP: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGSTOP

pub const TSTP: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGTSTP

pub const TTIN: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGTTIN

pub const TTOU: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGTTOU

pub const URG: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGURG

pub const XCPU: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGXCPU

pub const XFSZ: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGXFSZ

pub const VTALARM: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGVTALRM

pub const PROF: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGPROF

pub const WINCH: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and non-target_os=vita only.

SIGWINCH

pub const IO: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and neither Haiku nor target_os=vita only.

SIGIO, aka SIGPOLL

pub const POWER: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) and neither bsd nor Haiku nor target_os=horizon nor target_os=hurd nor target_os=vita only.

SIGPWR

pub const SYS: Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

SIGSYS, aka SIGUNUSED

impl Signal

pub const fn as_raw(self) -> i32

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a Signal to a raw signal number.

To convert to a NonZeroI32, use Signal::as_raw_nonzero.

pub const fn as_raw_nonzero(self) -> NonZeroI32

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a Signal to a raw non-zero signal number.

pub const unsafe fn from_raw_unchecked(sig: i32) -> Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a raw signal number into a Signal without checks.

For a safe checked version, see Signal::from_raw in rustix-libc-wrappers.

Safety

sig must be a valid and non-zero signal number.

And, if sig is a signal number reserved by the libc, such as a value from the libc SIGRTMIN to the libc SIGRTMAX, inclusive, then the resulting Signal must not be used to send, consume, or block any signals or alter any signal handlers.

pub const unsafe fn from_raw_nonzero_unchecked(sig: NonZeroI32) -> Self

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a raw non-zero signal number into a Signal without checks.

For a safe checked version, see Signal::from_raw_nonzero in rustix-libc-wrappers.

Safety

sig must be a valid signal number.

And, if sig is a signal number reserved by the libc, such as a value from SIGRTMIN to SIGRTMAX inclusive, then the resulting Signal must not be used to send, consume, or block any signals or alter any signal handlers.

pub const fn from_named_raw(sig: i32) -> Option<Self>

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a raw named signal number into a Signal.

If the given signal number corresponds to one of the named constant signal values, such as Signal::HUP or Signal::INT, return the Signal value. Otherwise return None.

Signals in the range SIGRTMIN through SIGRTMAX are not supported by this function. For a constructor that does recognize those values, see Signal::from_raw in rustix-libc-wrappers.

pub const fn from_named_raw_nonzero(sig: NonZeroI32) -> Option<Self>

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

Convert a raw non-zero named signal number into a Signal.

If the given signal number corresponds to one of the constant signal values, such as Signal::HUP or Signal::INT, return the Signal value. Otherwise return None.

Signals in the range SIGRTMIN through SIGRTMAX are not supported by this function. For a constructor that does recognize those values, see Signal::from_raw_nonzero in rustix-libc-wrappers.

Trait Implementations

impl Clone for Signal

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

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

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

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

Formats the value using the given formatter.

impl PartialEq for Signal

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

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

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

impl Eq for Signal

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.

impl StructuralPartialEq for Signal

Available on neither Windows nor target_os=espidf nor WASI and (crate feature io_uring, or crate feature process, or crate feature runtime, or bsd and crate feature event) only.