Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

Hierarchical, cooperative shutdown token.

Cloning a token is cheap: all clones share the same underlying state. Child tokens notify their parent on ShutdownToken::signal_shutdown, so any component can request a process-wide shutdown.

Implementations

impl ShutdownToken

pub fn new() -> Self

Create a root shutdown token with no parent.

pub fn child(&self) -> Self

Derive a child token that propagates its shutdown signal to self.

Calling ShutdownToken::signal_shutdown on the child will also signal the parent. The child has its own internal flag, so a parent that is already shutdown will not cause spurious wakeups on a freshly-created child.

pub fn signal_shutdown(&self)

Signal shutdown. Idempotent; subsequent calls are no-ops.

pub fn is_shutdown(&self) -> bool

Returns true if ShutdownToken::signal_shutdown has been called on this token or any of its ancestors.

pub async fn wait(&self)

Wait for a shutdown signal. Returns immediately if one has already been signalled.

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.

impl Default for ShutdownToken

fn default() -> ShutdownToken

Returns the “default value” for a type.