Struct ShutdownCoordinator 

pub struct ShutdownCoordinator { /* private fields */ }

A shutdown coordinator for triggering, and optionally waiting for, tasks to shut down.

Callers register a ShutdownHandle, which can be awaited to observe shutdown being triggered, or checked synchronously via ShutdownHandle::is_triggered. When a handle is dropped, it reports completion back to the coordinator; this is what allows shutdown_and_wait to block until every outstanding handle has finished.

Shutdown is triggered either fire-and-forget, via shutdown, or blocking, via shutdown_and_wait.

Shutdown on drop

Shutdown is also triggered implicitly on drop if it hasn’t already been triggered, to enforce that shutdown always happens even in exceptional circumstances. Shutdown on drop is fire-and-forget: when the coordinator’s drop logic has executed, there is no guarantee that all outstanding handles have also been dropped.

Implementations

impl ShutdownCoordinator

pub fn register(&mut self) -> ShutdownHandle

Registers and returns a new shutdown handle.

pub fn shutdown(self)

Signals shutdown to all outstanding handles without waiting.

When it is desirable to wait until all outstanding handles have completed (been dropped), use shutdown_and_wait.

pub async fn shutdown_and_wait(self)

Signals shutdown to all outstanding handles, waiting until all handles have completed (been dropped).

If there are no outstanding handles, this returns immediately.

Trait Implementations

impl Default for ShutdownCoordinator

fn default() -> ShutdownCoordinator

Returns the “default value” for a type.

impl Drop for ShutdownCoordinator

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.