Struct ShutdownReceiver

pub struct ShutdownReceiver { /* private fields */ }

Contains methods to wait for a “clean shutdown” signal in asynchronous tasks.

Implementations

impl ShutdownReceiver

pub async fn watch(&mut self)

Waits for this ShutdownReceiver’s corresponding ShutdownSender to signal that it’s time to shutdown. Doesn’t return until then.

The ShutdownReceiver MUST be dropped as a result of this method returning.

pub fn spawn_with_shutdown<T>( shutdown: ShutdownReceiver, todo: T, task_name: impl Display + Send + 'static + Sync, timeout: Option<Duration>, )

where T: Future + Send + 'static, T::Output: Send + 'static,

Spawn a new async task that will automatically be dropped when the provided ShutdownReceiver is signaled.

Trait Implementations

impl Clone for ShutdownReceiver

fn clone(&self) -> ShutdownReceiver

Returns a duplicate of the value.

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

Performs copy-assignment from source.