Struct KillSwitch

pub struct KillSwitch { /* private fields */ }

Convenience type which wraps a AtomicBool. Initially, is_alive() will return true. The value can be cloned across threads, and once it has been kill()ed, then all of the clones will return false from is_alive().

Implementations

impl KillSwitch

pub fn is_alive(&self) -> bool

Check if the kill switch has been flipped. Before flipping will return true, and afterwards will return false

pub fn kill(&self) -> Result<(), KillSwitchErr>

Flip the kill switch (will cause is_alive() to return false

pub fn watcher(&self) -> KillSwitchWatcher

Produce a kill switch which can only watch the value, but cannot flip the switch

Trait Implementations

impl Clone for KillSwitch

fn clone(&self) -> KillSwitch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KillSwitch

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

Formats the value using the given formatter.

impl Default for KillSwitch

fn default() -> Self

Returns the “default value” for a type.

impl Display for KillSwitch

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

Formats the value using the given formatter.