Struct EBrake 

pub struct EBrake { /* private fields */ }

The emergency brake is a circular queue of boolean samples with a defined size and tolerance.

Implementations

impl EBrake

pub fn new(samples: usize, tolerance: usize) -> Self

Creates a new Emergency Brake with the given number of samples and tolerance.

use emergency_brake::EBrake;
let ebrake = EBrake::new(10, 3);

Trait Implementations

impl Clone for EBrake

fn clone(&self) -> EBrake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EBrake

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

Formats the value using the given formatter.

impl Default for EBrake

fn default() -> EBrake

Returns the “default value” for a type.

impl EmergencyBrake for EBrake

fn add_sample(&mut self, sample: bool)

Insert a sample into the emergency brake. This will pop the oldest sample if the queue is full. true indicates a success, false indicates a failure.

fn should_trigger(&self) -> bool

Returns true if the emergency brake should be triggered. Returns false if the emergency brake should not be triggered.

fn trigger(&self, trigger: &'static Trigger) -> bool

Returns false if the emergency brake has not been triggered. If the emergency brake has been triggered, the process supplied trigger action will be executed.

fn trigger_abort(&self) -> bool

Returns false if the emergency brake has not been triggered. If the emergency brake has been triggered, the process will be aborted.

fn trigger_panic(&self) -> bool

Returns false if the emergency brake has not been triggered. If the emergency brake has been triggered, a panic will occur.

fn trigger_on_sample(&mut self, sample: bool, trigger: &'static Trigger) -> bool

Insert a sample and check if the emergency brake should be triggered.