Struct Stopping 

pub struct Stopping(pub(crate) Receiver<bool>);

One observation of the stop signal for a whole run, installed once at its start and awaited by everything that stops on it.

A handler installed partway through startup misses a stop sent before it. This one remembers: a stop that arrived while startup was busy is still there for Stopping::wait when serving begins.

Tuple Fields

0: Receiver<bool>

Implementations

impl Stopping

pub fn install() -> Self

Installs the handlers now. Needs a running tokio runtime.

pub fn when(stopped: Receiver<bool>) -> Self

A stop that arrives once stopped reads true, for a caller that decides for itself when a run stops.

pub fn never() -> Self

A stop that never arrives.

pub async fn wait(self)

Resolves once a stop has arrived, at once if one already has.

pub fn after(self, work: impl Future<Output = ()> + Send + 'static) -> Self

This stop, arriving only once work has run after it.

For what has to happen while the process still serves: everything that waits on the returned one keeps going until work is done. work is not polled before the stop arrives.

Trait Implementations

impl Clone for Stopping

fn clone(&self) -> Stopping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stopping

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

Formats the value using the given formatter.