Enum Alert 

pub enum Alert {
    OutOfRange {
        reading: f32,
    },
    RunningOut {
        samples: u32,
    },
    ChangingFast {
        rate: f32,
    },
}

An alert raised when a reading crosses a profile’s safety threshold.

Variants

OutOfRange

A controlled reading drifted outside its safe band.

For a cold-chain fridge this is a spoilage excursion: the cooler may be running, but the contents are no longer within the safe temperature range.

Fields

reading: f32

The reading that triggered the alert.

RunningOut

A falling level will reach its empty mark within this many more samples.

Fields

samples: u32

The estimated number of samples until the level reaches empty.

ChangingFast

A reading is changing faster than its safe rate.

For a river gauge this is a flash-flood warning: the level jumped further in one sample than the profile allows.

Fields

rate: f32

The change since the previous sample, as a positive number.

Implementations

impl Alert

pub fn kind(self) -> &'static str

Returns the name of the condition, without the measurement that triggered it.

The bindings carry an alert as a kind and a value, so this is the same word in every language, which is what lets one reading be logged or compared the same way wherever the node’s code is written.

Returns

One of "OutOfRange", "RunningOut", or "ChangingFast".

Trait Implementations

impl Clone for Alert

fn clone(&self) -> Alert

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Alert

impl Debug for Alert

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

Formats the value using the given formatter.

impl PartialEq for Alert

fn eq(&self, other: &Alert) -> 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.

impl StructuralPartialEq for Alert