Struct async_shutdown::ShutdownSignal

pub struct ShutdownSignal { /* fields omitted */ }

A future to wait for a shutdown signal.

The future completes when the associated Shutdown triggers a shutdown.

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

Implementations

impl ShutdownSignal

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

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

The returned future completes with None when a shutdown is triggered, and with Some(x) when the wrapped future completes.

The wrapped future is dropped when the shutdown starts before the future completed. If the wrapped future completes before the shutdown signal arrives, it is not dropped.

Trait Implementations

impl Clone for ShutdownSignal

fn clone(&self) -> ShutdownSignal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Future for ShutdownSignal

type Output = ()

The type of value produced on completion.

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

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