Struct Stopper

pub struct Stopper { /* private fields */ }

A basic cancellation-token

Used to terminate (and signal termination of) worker tasks

Implementations

impl Stopper

pub fn new() -> Self

Create a new Stopper

pub async fn wait_stopped(&self)

Wait until the stopper has been stopped.

Once this completes, the stopper has been permanently stopped

pub fn is_stopped(&self) -> bool

Have we been stopped?

pub fn stop(&self)

Stop the stopper

All current and future calls to Self::wait_stopped will complete immediately

Trait Implementations

impl Clone for Stopper

fn clone(&self) -> Stopper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Stopper

fn default() -> Self

Returns the “default value” for a type.