Struct ShutdownSignal 

pub struct ShutdownSignal { /* private fields */ }

An application-owned process-shutdown signal.

Implementations

impl ShutdownSignal

pub fn request_shutdown(&self) -> ShutdownRequest

Stops intake on the first request and escalates waiting on the second.

pub fn is_shutdown_requested(&self) -> bool

Returns whether shutdown has stopped new intake.

pub fn is_escalated(&self) -> bool

Returns whether a second request escalated join waiting.

pub async fn cancelled(&self)

Waits for the first request.

pub fn ensure_accepting(&self) -> Result<(), ShutdownError>

Rejects new work after the first shutdown request.

Errors

Returns ShutdownError::ShuttingDown once intake has stopped.

Trait Implementations

impl Clone for ShutdownSignal

fn clone(&self) -> ShutdownSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownSignal

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

Formats the value using the given formatter.