Struct KillSwitch

pub struct KillSwitch { /* private fields */ }

An object that can be used to terminate an instance’s execution from a separate thread.

Implementations

impl KillSwitch

pub fn terminate(&self) -> Result<KillSuccess, KillError>

Signal the instance associated with this KillSwitch to stop, if possible.

The returned Result only describes the behavior taken by this function, not necessarily what caused the associated instance to stop.

As an example, if a KillSwitch fires, sending a SIGALRM to an instance at the same moment it begins handling a SIGSEGV which is determined to be fatal, the instance may stop with State::Faulted before actually handling the SIGALRM we’d send here. So the host code will see State::Faulted as an instance state, where KillSwitch::terminate would return Ok(KillSuccess::Signalled).