Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

A cloneable, awaitable process-shutdown handle with one shared drain deadline.

Child tokens observe parent shutdown, while calling ShutdownToken::trigger on any child still initiates process-wide shutdown. The deadline begins with the first trigger and is shared by all clones and children.

Implementations

impl ShutdownToken

pub fn new(drain_timeout: Duration) -> Self

Creates a shutdown handle with the maximum duration allowed for draining.

pub fn child_token(&self) -> Self

Returns a child which is cancelled by this token.

Triggering the child deliberately triggers the shared process token too.

pub fn trigger(&self) -> bool

Initiates process-wide shutdown and returns whether this was the first trigger.

pub fn on_drain<F>(&self, hook: F)

where F: FnOnce() + Send + 'static,

Registers a fast synchronous action to run when drain begins.

Hooks run exactly once on the first ShutdownToken::trigger, before cancellation wakes asynchronous drain work. A hook registered after drain has started runs immediately. This is the dependency-neutral composition seam for closing baukit_ops::TrafficGate without a watcher task:

let shutdown = ShutdownToken::new(Duration::from_secs(30));
shutdown.on_drain({
    let traffic_gate = traffic_gate.clone();
    move || traffic_gate.stop_accepting()
});

Hooks should only flip in-memory state or perform similarly bounded work; asynchronous cleanup belongs in ShutdownToken::run_during_drain.

pub fn is_cancelled(&self) -> bool

Returns whether this token has observed shutdown.

pub async fn cancelled(&self)

Waits until process-wide shutdown reaches this token.

pub const fn drain_timeout(&self) -> Duration

Returns the configured drain timeout.

pub fn deadline(&self) -> Option<Instant>

Returns the shared absolute drain deadline after shutdown has begun.

pub async fn run_during_drain<F>( &self, future: F, ) -> Result<F::Output, DrainTimeout>

where F: Future,

Waits for shutdown, then runs future within the remaining drain budget.

Every call uses the same absolute deadline, so sequential cleanup steps cannot accidentally receive a fresh timeout. On expiry, the future is dropped and DrainTimeout is returned.

pub async fn shutdown_on_signal(&self) -> Result<ShutdownSignal>

Waits for SIGINT/SIGTERM (or the platform Ctrl-C event), then triggers shutdown.

pub fn spawn_signal_listener(&self) -> JoinHandle<Result<ShutdownSignal>>

Spawns a Tokio task which triggers shutdown on the first process signal.

The returned task reports signal-handler setup failures when joined.

Trait Implementations

impl Clone for ShutdownToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownToken

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

Formats the value using the given formatter.