Struct lair_keystore_api::internal::util::KillSwitch

pub struct KillSwitch { /* fields omitted */ }

If any clones of this struct are dropped, they all say we should stop looping. You can mix in a future that will abort if the kill switch is triggered.

Implementations

impl KillSwitch

pub fn new() -> Self

Create a new kill switch

pub fn weak(&self) -> Self

Get a “Weak” version of this kill_switch that will allow mixing/checking the kill status, but will not kill other instances when dropped.

pub fn make_weak(&mut self)

Convert this kill_switch to a “Weak” version that will not kill other insances when dropped.

pub async fn register_kill_callback(&self, cb: KillCallback)

Register an async callback that will be invoked on kill.

pub fn cont(&self) -> bool

Should we continue?

pub async fn mix<R, F>(&self, f: F) -> LairResult<R> where
    F: Future<Output = LairResult<R>>, 

Mix in another future so it will abort if this kill switch is triggered.

pub fn mix_static<R, F>(
    &self,
    f: F
) -> impl Future<Output = LairResult<R>> + 'static where
    F: 'static + Future<Output = LairResult<R>>, 

Mix in another future so it will abort if this kill switch is triggered. Sometimes we need static futures.

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 Default for KillSwitch

fn default() -> Self

Returns the “default value” for a type.

impl Drop for KillSwitch

fn drop(&mut self)

Executes the destructor for this type.