Struct UnixGracefulShutdown 

pub struct UnixGracefulShutdown { /* private fields */ }

One or more graceful-shutdown phases dispatched on Unix before the implicit SIGKILL fallback.

Always followed by SIGKILL if every configured phase elapses without the child exiting.

Choosing a sequence

Recommended for service-like children (default for most orchestrators): UnixGracefulShutdown::terminate_only. SIGTERM is the standard Unix shutdown signal: kill <pid>, systemd, K8s, Docker, runit, and supervisord all send it. Most well-behaved long-running services install a SIGTERM handler.

Recommended for CLI-like children: UnixGracefulShutdown::interrupt_only. Use when the orchestrator’s user model is “I pressed Ctrl-C” and the child is expected to handle SIGINT (Tokio tokio::signal::ctrl_c(), Python KeyboardInterrupt, and similar).

Multi-phase sequences via from_phases are NOT a way to cover children with unknown signal handlers. If phase 1 sends a signal whose handler is missing in the child, the kernel default disposition (Term) kills the child during phase 1 and later phases are never dispatched. A two-phase SIGINT -> SIGTERM sequence does not “cover both conventions”: a child that handles only SIGTERM is killed by the SIGINT phase via kernel default before its SIGTERM handler can run, and the symmetric problem occurs for SIGTERM -> SIGINT against SIGINT-only-handler children.

Use multi-phase only when you control the child and use multiple signals as distinct cooperative shutdown stages (for example: SIGINT “begin drain” followed by SIGTERM “abort drain”). For unknown or heterogeneous children, pick terminate_only or interrupt_only.

Construction

UnixGracefulShutdown cannot be constructed empty. The implicit SIGKILL fallback is not a phase; a graceful sequence must contain at least one signal to dispatch. Use one of the named single-signal constructors, or from_phases for a multi-phase cooperative sequence.

Implementations

impl UnixGracefulShutdown

pub fn terminate_only(timeout: Duration) -> Self

Single-phase sequence sending SIGTERM only. The recommended default for service-like children; see the type-level docs for the full discussion. The implicit SIGKILL fallback runs after timeout if the child has not exited.

pub fn interrupt_only(timeout: Duration) -> Self

Single-phase sequence sending SIGINT only. Use this when forwarding a Ctrl-C / TTY interrupt to a CLI-like child; see the type-level docs for the full discussion. The implicit SIGKILL fallback runs after timeout if the child has not exited.

pub fn from_phases(phases: impl IntoIterator<Item = UnixGracefulPhase>) -> Self

Multi-phase sequence dispatched in iteration order. Use only for cooperative shutdown protocols against a child you control, where each signal in the sequence has a distinct handler. For unknown children pick Self::terminate_only or Self::interrupt_only instead; see the type-level docs for why a multi-phase sequence does not “cover both conventions”.

Panics

Panics if phases produces no elements. A graceful sequence must contain at least one phase; the implicit SIGKILL fallback is not a phase.

pub fn phases(&self) -> &[UnixGracefulPhase]

Phases in dispatch order.

Trait Implementations

impl Clone for UnixGracefulShutdown

fn clone(&self) -> UnixGracefulShutdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnixGracefulShutdown

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

Formats the value using the given formatter.

impl PartialEq for UnixGracefulShutdown

fn eq(&self, other: &UnixGracefulShutdown) -> 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 Eq for UnixGracefulShutdown

impl StructuralPartialEq for UnixGracefulShutdown