Struct TofAlert

pub struct TofAlert<'a> {
    pub key: &'a str,
    pub descr: &'a str,
    pub whattodo: Vec<&'a str>,
    pub config: TofAlertConfig,
    pub variable: Variable,
    pub component: Component,
    pub outofbound: OutOfBound,
    pub triggered: Option<Instant>,
    pub n_paged: u32,
}

Alerts are clues to trigger a reaction of an individual, so they are designed for humans, but should be issued by a machine

ISSUES: The design choice of going with a &str here and carry the livetime around is admittedly a bit questionable, especially since we might want to create similar alerts automatically (which I did not think of earlier)

Fields

key: &'a str

a unique identifier so that we can look this up in settings

descr: &'a str

description of what had happened

whattodo: Vec<&'a str>

recommended course of action

config: TofAlertConfig

The configurable part of the alerm, subscirbers, bounds and is the alarm armed

variable: Variable

The variable which is an issue, e.g Rate

component: Component

The part of the TofSystem which caused the issue

outofbound: OutOfBound

How did the variable get out-of-bounds? E.g. too high, too low?

triggered: Option<Instant>

When did this issue occur?

n_paged: u32

How often did this alert page?

Implementations

impl TofAlert<'_>

pub fn acknowledge(&mut self)

pub fn has_triggered(&self) -> bool

pub fn format_page(&self) -> String

pub fn get_text(&self) -> String

pub fn trigger(&mut self, val: f32)

pub fn page(&mut self)

pub fn configure_from_manifest(&mut self, manifest: &TofAlertManifest)

Trait Implementations

impl<'a> Clone for TofAlert<'a>

fn clone(&self) -> TofAlert<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TofAlert<'a>

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

Formats the value using the given formatter.

impl Display for TofAlert<'_>

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

Formats the value using the given formatter.

impl PartialEq for TofAlert<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.