Struct Reading 

pub struct Reading {
    pub key: String,
    pub value: f32,
    pub unit: String,
    pub status: Status,
    pub band: Option<[f32; 2]>,
    pub viz: Option<String>,
    pub trend: Option<Trend>,
    pub state: Option<String>,
    pub actions: Option<Vec<String>>,
    pub stat: bool,
}

A single measured value, named by a stable key and a canonical unit.

Fields

key: String

A stable, language-neutral element key, such as "soil_moisture".

value: f32

The raw measured value, in the canonical unit.

unit: String

The canonical unit name, such as "percent", "celsius", or "volt".

status: Status

The health of this reading on its own.

band: Option<[f32; 2]>

The safe band [low, high] in the same unit, drawn as the gauge’s safe zone.

viz: Option<String>

An explicit visualization kind that overrides the page’s key/unit heuristic, such as "radial" or "bar". Set from a profile’s Viz with with_viz so a custom reading is drawn the way its profile intends; None lets the page pick from the key and unit.

trend: Option<Trend>

Which way the reading is moving, if known.

state: Option<String>

A discrete state code for a non-numeric reading, such as "state.open" for a valve or "pump.nominal" for a pump, which the page renders as a labelled chip. Numeric readings leave this None.

actions: Option<Vec<String>>

The discrete actions this reading can be commanded to, such as ["open", "closed"] for a valve. Present only on a controllable actuator; a read-only sensor leaves this None, and the page shows control only when it is set.

stat: bool

Whether this is a node or network stat (neighbours, hops, link or relay status, a tamper-log record count) rather than a measurement of the world. The page counts and renders stats apart from sensors. Defaults false.

Implementations

impl Reading

pub fn new(key: impl Into<String>, value: f32, unit: impl Into<String>) -> Self

Creates a reading in good standing with no band or trend.

Arguments

• key - the stable element key.
• value - the raw measured value.
• unit - the canonical unit name.

Returns

A Status::Ok reading carrying just the value and unit.

pub fn with_status(self, status: Status) -> Self

Sets the reading’s health.

Arguments

• status - the health to record.

Returns

The reading, for chaining.

pub fn with_band(self, low: f32, high: f32) -> Self

Sets the safe band drawn as the gauge’s safe zone.

Arguments

• low - the bottom of the safe band.
• high - the top of the safe band.

Returns

The reading, for chaining.

pub fn with_viz(self, viz: Viz) -> Self

Pins the graphic this reading is drawn with, overriding the page’s heuristic.

Use this when a profile declares a custom element with Viz and you want the live reading drawn the same way, regardless of its key and unit.

Arguments

• viz - the graphic to draw the reading with.

Returns

The reading, for chaining.

pub fn with_trend(self, trend: Trend) -> Self

Sets the reading’s trend arrow.

Arguments

• trend - which way the reading is moving.

Returns

The reading, for chaining.

pub fn with_state(self, state: impl Into<String>) -> Self

Sets a discrete state code for a non-numeric reading, rendered as a chip.

Arguments

• state - the stable state code, such as "state.open".

Returns

The reading, for chaining.

pub fn with_actions( self, actions: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Marks the reading as a controllable actuator with the given discrete actions.

Arguments

• actions - the action codes a client may command, such as ["open", "closed"].

Returns

The reading, for chaining.

pub fn as_stat(self) -> Self

Marks the reading as a node or network stat rather than a measurement, so the page counts and renders it apart from sensors.

Returns

The reading, for chaining.

Trait Implementations

impl Clone for Reading

fn clone(&self) -> Reading

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reading

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reading

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Reading

fn eq(&self, other: &Reading) -> 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 Serialize for Reading

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reading