Struct ShutdownHandle 

pub struct ShutdownHandle { /* private fields */ }

A handle for observing shutdown from a ShutdownCoordinator.

The handle is a Future that resolves once shutdown is triggered, and can also be checked synchronously via is_triggered. Dropping the handle reports completion back to its coordinator, which is how ShutdownCoordinator::shutdown_and_wait knows when all outstanding work has finished.

Implementations

impl ShutdownHandle

pub fn noop() -> Self

Creates a shutdown handle that is never triggered.

This can be useful when a callee requires a handle but no shutdown signal is expected or available to provide.

pub fn paired() -> (ShutdownCoordinator, Self)

Creates a coordinator/handle pair.

This is equivalent to creating ShutdownCoordinator and calling ShutdownCoordinator::register. The resulting coordinator can still be used to register further handles if need be.

pub fn is_triggered(&self) -> bool

Returns true if shutdown has been triggered.

Trait Implementations

impl Drop for ShutdownHandle

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.

impl Future for ShutdownHandle

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'pin> Unpin for ShutdownHandle

where PinnedFieldsOf<__ShutdownHandle<'pin>>: Unpin,