Struct Watcher 

pub struct Watcher { /* private fields */ }

A loop’s view of the stop signal.

Cheap to clone, and safe to hold across an await.

Implementations

impl Watcher

pub fn is_stopping(&self) -> bool

Whether a stop has been requested.

The condition a while loop tests between units of work.

pub fn is_running(&self) -> bool

Whether the loop should keep going.

The inverse of Watcher::is_stopping, spelled the way a loop reads best: while watcher.is_running() { … }.

pub async fn wait(&self)

Wait until a stop is requested.

Returns immediately if one already has been. Use it with select! to cut a long operation short.

pub async fn sleep(&self, duration: Duration) -> bool

Sleep, unless a stop is requested first.

Returns true if the sleep completed, false if it was cut short.

Examples

use std::time::Duration;
use graceful_worker::Shutdown;

let shutdown = Shutdown::new();
let watcher = shutdown.watcher();
shutdown.stop();

// Already stopping, so the sleep is abandoned rather than served.
assert!(!watcher.sleep(Duration::from_secs(900)).await);

Trait Implementations

impl Clone for Watcher

fn clone(&self) -> Watcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Watcher

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

Formats the value using the given formatter.