Struct Shutdown 

pub struct Shutdown { /* private fields */ }

Shutdown coordinator.

A Shutdown can create many ShutdownToken clones; calling Shutdown::trigger transitions the shutdown flag to “true” and wakes any threads blocked in ShutdownToken::wait / ShutdownToken::wait_timeout.

Contract: shutdown is one-way and idempotent.

Implementations

impl Shutdown

pub fn new() -> Self

Create a new shutdown coordinator.

pub fn token(&self) -> ShutdownToken

Create a clonable token that can observe shutdown.

pub fn trigger(&self) -> bool

Trigger shutdown.

Returns true if this call transitioned from not-shutdown to shutdown.

Notes: this notifies all waiters even if shutdown was already triggered.

Trait Implementations

impl Default for Shutdown

fn default() -> Self

Returns the “default value” for a type.