Enum OperatorSignal 

pub enum OperatorSignal {
    Hup,
    Int,
    Quit,
    Term,
    Usr1,
    Usr2,
    Winch,
    Cont,
    Kill,
}

A signal shep signal may name.

Nine, not every signal on the platform: each is something an operator plausibly means to say to an application. Nothing here is a signal shep would deliver on the kernel’s behalf (SIGSEGV, SIGBUS, SIGPIPE and the rest are the kernel’s to send).

Exhaustive, not #[non_exhaustive]: a caller matching on all nine should get a compile error the day a tenth arrives, not a silent wildcard arm.

Variants

Hup

SIGHUP: hang up, the near-universal “re-read your configuration”.

Int

SIGINT: interrupt, what Ctrl-C sends.

Quit

SIGQUIT: quit, core-dumping by default. Several runtimes dump every thread’s stack on it instead.

Term

SIGTERM: the polite stop. Sending it here bypasses the stop ladder entirely: shep does not start a kill_timeout, does not escalate, and does not mark the sheep stopped. Use shep stop for a stop.

Usr1

SIGUSR1: user-defined signal 1.

Usr2

SIGUSR2: user-defined signal 2, the one several runtimes reserve for a graceful restart.

Winch

SIGWINCH: terminal resized. Harmless to nearly everything, which is what makes it the signal to test a wiring with.

Cont

SIGCONT: continue a stopped process.

Kill

SIGKILL: unblockable, immediate. The restart policy will see the exit as any other unexpected one and act on it: an app with autorestart on comes back.

Implementations

impl OperatorSignal

pub const ACCEPTED: [&'static str; 9]

Every spelling this grammar accepts, canonical form, in the order a refusal lists them.

Public because it is rendered into the refusal an operator reads and into shep signal --help; a second hand-written list in either place is one free to drift.

pub fn parse(name: &str) -> Option<Self>

Parses one signal name, case-insensitively, with or without the SIG prefix. None for anything else, including a raw number: a number means different signals on different platforms, and shep will not guess which one an operator meant.

pub fn as_str(self) -> &'static str

The canonical name, always SIG-prefixed and uppercase.

Trait Implementations

impl Clone for OperatorSignal

fn clone(&self) -> OperatorSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OperatorSignal

impl Debug for OperatorSignal

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

Formats the value using the given formatter.

impl Eq for OperatorSignal

impl PartialEq for OperatorSignal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OperatorSignal