Struct Metric 

pub struct Metric {
    pub name: Option<String>,
    pub alias: Option<u64>,
    pub timestamp: Option<u64>,
    pub value: MetricValue,
    pub is_historical: Option<bool>,
    pub is_transient: Option<bool>,
    pub metadata: Option<MetaData>,
    pub properties: Option<PropertySet>,
}

A single named/aliased typed value — the unit of all Sparkplug data.

name and alias are both optional: BIRTH metrics carry the name (and, when aliasing, an alias); DATA metrics may carry only the alias (tck-id-payloads-alias-data-cmd-requirement).

Fields

name: Option<String>

Metric name (required on BIRTH unless aliasing — tck-id-payloads-name-requirement).

alias: Option<u64>

Metric alias (unique per Edge Node — tck-id-payloads-alias-uniqueness).

timestamp: Option<u64>

Acquisition timestamp, epoch milliseconds UTC.

value: MetricValue

The typed value (carries the datatype; Null carries the declared type).

is_historical: Option<bool>

Whether this is historical data (should not update the live tag).

is_transient: Option<bool>

Whether this value should not be stored as a tag.

metadata: Option<MetaData>

Optional metadata (esp. for Bytes/File/multi-part transfers).

properties: Option<PropertySet>

Optional property set (engineering units, quality, …).

Implementations

impl Metric

pub fn new(name: impl Into<String>, value: MetricValue) -> Self

A named metric with the given value and no other fields set.

pub fn aliased(alias: u64, value: MetricValue) -> Self

An alias-only metric (no name), as used in DATA/CMD messages.

pub fn with_alias(self, alias: u64) -> Self

Builder-style setter for the alias.

pub fn with_timestamp(self, ts: u64) -> Self

Builder-style setter for the timestamp (epoch ms).

pub fn with_properties(self, props: PropertySet) -> Self

Builder-style setter for the property set.

pub fn datatype(&self) -> DataType

The datatype this metric declares on the wire.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl PartialEq for Metric

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