Struct drain::Watch

pub struct Watch { /* fields omitted */ }

Watch for a drain command.

All Watch instances must be dropped for a Signal::signal call to complete.

Implementations

impl Watch

pub async fn signaled(self) -> ReleaseShutdown

Returns a ReleaseShutdown handle after the drain has been signaled. The handle must be dropped when a shutdown action has been completed to unblock graceful shutdown.

pub fn ignore_signaled(self) -> ReleaseShutdown

Return a ReleaseShutdown handle immediately, ignoring the release signal.

This is intended to allow a task to block shutdown until it completes.

pub async fn watch<A, F>(self, future: A, on_drain: F) -> A::Output where
    A: Future + Unpin,
    F: FnOnce(&mut A), 

Wrap a future and a callback that is triggered when drain is received.

The callback receives a mutable reference to the original future, and should be used to trigger any shutdown process for it.

Trait Implementations

impl Clone for Watch

fn clone(&self) -> Watch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Watch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.