Struct OrderedShutdown 

pub struct OrderedShutdown { /* private fields */ }

The shutdown coordinator. Clones share one shutdown.

Implementations

impl OrderedShutdown

pub fn new() -> Self

pub fn phase( self, name: impl Into<String>, deadline: Duration, run: impl FnOnce() -> Result<(), String> + Send + 'static, ) -> Self

Append a phase. Phases run in the order added. deadline bounds this phase (a zero deadline is raised to 1 ms). Ignored once the shutdown has started.

pub fn watchdog(self, hard_deadline: Duration, exit_code: i32) -> Self

End the process with exit_code when the whole shutdown has not finished hard_deadline after it started. Without it there is no watchdog.

pub fn on_watchdog(self, exit: impl Fn(i32) + Send + Sync + 'static) -> Self

Replace what the watchdog does (default: std::process::exit(code)), for a host that must do its own last write first.

pub fn run(&self) -> ShutdownReport

Run the shutdown, or wait for the run already in flight and return its report.

Trait Implementations

impl Clone for OrderedShutdown

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OrderedShutdown

fn default() -> Self

Returns the “default value” for a type.