Struct ShutdownSignal

pub struct ShutdownSignal<T: Clone> { /* private fields */ }

A future to wait for a shutdown signal.

The future completes when the associated ShutdownManager triggers a shutdown.

The shutdown signal can be cloned and sent between threads freely.

Implementations

impl<T: Clone> ShutdownSignal<T>

pub fn wrap_cancel<F: Future>(&self, future: F) -> WrapCancel<T, F>

Wrap a future so that it is cancelled when a shutdown is triggered.

The returned future completes with Err(reason) containing the shutdown reason if a shutdown is triggered, and with Ok(x) when the wrapped future completes.

The wrapped future is dropped if the shutdown starts before the wrapped future completes.

Trait Implementations

impl<T: Clone> Clone for ShutdownSignal<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone> Drop for ShutdownSignal<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Clone> Future for ShutdownSignal<T>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, context: &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.