Enum Stopper 

pub enum Stopper {
    Running {
        signaler: Option<Signaler>,
        signal: Signal,
    },
    Stopped {
        stop_value: i32,
        completion: Shared<Receiver<()>>,
    },
}

Employs Signaler to coordinate the graceful shutdown of many tasks.

Variants

Running

The stopper is running and stop has not been called yet.

Fields

signaler: Option<Signaler>

signal: Signal

Stopped

Stop has been called and completion is pending or resolved.

Fields

stop_value: i32

completion: Shared<Receiver<()>>

Implementations

impl Stopper

pub fn new() -> Self

Create a new stopper in running mode.

pub fn stopped(&self) -> Signal

Get the signal for runtime users to await.

pub fn stop(&mut self, value: i32) -> Shared<Receiver<()>>

Initiate shutdown returning a completion future. Always returns a completion future, even if stop was already called. If stop was already called, returns the same shared completion future that will resolve immediately if already completed.

Trait Implementations

impl Default for Stopper

fn default() -> Self

Returns the “default value” for a type.