Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

Cloneable observer handle.

Hand one of these to every subsystem that needs to react to shutdown. The handle is cheap to clone (single Arc::clone).

Implementations

impl ShutdownToken

pub fn is_initiated(&self) -> bool

true if shutdown has been initiated.

pub fn reason(&self) -> Option<ShutdownReason>

Reason for the shutdown, if one has been initiated.

pub fn elapsed(&self) -> Option<Duration>

Wall-clock time since shutdown was initiated.

pub fn wait_blocking(&self)

Block the current thread until shutdown is initiated.

Returns immediately if shutdown is already initiated.

pub fn wait_blocking_timeout(&self, timeout: Duration) -> bool

Block the current thread for at most timeout.

Returns true if shutdown was observed within the budget, false if the timeout elapsed first.

pub async fn wait(&self)

Available on crate feature tokio only.

Async wait point. Returns once shutdown is initiated.

Requires the tokio feature; the async-std variant takes precedence only when tokio is not enabled.

Trait Implementations

impl Clone for ShutdownToken

fn clone(&self) -> ShutdownToken

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.