Struct ShutdownGuard 

pub struct ShutdownGuard { /* private fields */ }

RAII guard that tracks shutdown state.

When all clones of a ShutdownGuard are dropped, the associated shutdown is considered complete. Cloning the guard and sending the clone to background tasks allows the main task to wait for all tasks to finish by dropping the original guard.

Implementations

impl ShutdownGuard

pub fn new() -> Self

Create a new shutdown guard.

pub fn shutdown(&self)

Signal shutdown to all clones of this guard.

pub fn is_shutdown(&self) -> bool

Check if shutdown has been signaled.

pub async fn wait_for_shutdown(&self)

Wait for shutdown to be signaled.

Trait Implementations

impl Clone for ShutdownGuard

fn clone(&self) -> ShutdownGuard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ShutdownGuard

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ShutdownGuard

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.