Struct AlarmUnit 

pub struct AlarmUnit {
    panic_on_unmasked_alarm: bool,
    masked: BTreeSet<AlarmKind>,
    active: BTreeMap<AlarmKind, Alarm>,
    changes: ChangeIndex<AlarmKind>,
}

An alarm is in one of the following states:

• inactive: it’s not happening
• firing: it’s happening and not masked (execution will stop)
• active but not firing (visible on the console, execution continues)

Fields

panic_on_unmasked_alarm: bool

masked: BTreeSet<AlarmKind>

active: BTreeMap<AlarmKind, Alarm>

changes: ChangeIndex<AlarmKind>

Implementations

impl AlarmUnit

pub fn new() -> AlarmUnit

fn status_for_alarm_kind(&self, kind: &AlarmKind) -> AlarmStatus

pub fn get_alarm_statuses(&self) -> Vec<AlarmStatus>

pub fn drain_alarm_changes(&mut self) -> BTreeMap<AlarmKind, AlarmStatus>

pub fn get_status_of_alarm(&self, name: &str) -> Option<AlarmStatus>

pub fn new_with_panic(panic: bool) -> AlarmUnit

pub fn mask( &mut self, kind: AlarmKind, diags: &CurrentInstructionDiagnostics, ) -> Result<(), Alarm>

pub fn unmask(&mut self, kind: AlarmKind)

fn is_masked(&self, alarm_instance: &Alarm) -> bool

fn maybe_panic(&self, alarm_instance: &Alarm)

pub fn clear_all_alarms(&mut self)

pub fn unmasked_alarm_active(&self) -> bool

fn set_active(&mut self, alarm_instance: Alarm) -> Result<(), Alarm>

Trait Implementations

impl Alarmer for AlarmUnit

fn fire_if_not_masked<F: DiagnosticFetcher>( &mut self, alarm_instance: Alarm, _get_diags: F, ) -> Result<(), Alarm>

Fire the indicated alarm if it is not masked.

fn always_fire<F: DiagnosticFetcher>( &mut self, alarm_instance: Alarm, get_diagnostics: F, ) -> Alarm

Unconditionally fire the indicated alarm.

impl Debug for AlarmUnit

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

Formats the value using the given formatter.

impl Default for AlarmUnit

fn default() -> AlarmUnit

Returns the “default value” for a type.