Struct Metric

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

Fields

name: Option<String>

Metric name - should only be included on birth

alias: Option<u64>

Metric alias - tied to name on birth and included in all later DATA messages

timestamp: Option<u64>

Timestamp associated with data acquisition time

datatype: Option<u32>

DataType of the metric/tag value

is_historical: Option<bool>

If this is historical data and should not update real time tag

is_transient: Option<bool>

Tells consuming clients such as MQTT Engine to not store this as a tag

is_null: Option<bool>

If this is null - explicitly say so rather than using -1, false, etc for some datatypes.

metadata: Option<MetaData>

Metadata for the payload

properties: Option<PropertySet>

value: Option<Value>

Implementations

impl Metric

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn alias(&self) -> u64

Returns the value of alias, or the default value if alias is unset.

pub fn timestamp(&self) -> u64

Returns the value of timestamp, or the default value if timestamp is unset.

pub fn datatype(&self) -> u32

Returns the value of datatype, or the default value if datatype is unset.

pub fn is_historical(&self) -> bool

Returns the value of is_historical, or the default value if is_historical is unset.

pub fn is_transient(&self) -> bool

Returns the value of is_transient, or the default value if is_transient is unset.

pub fn is_null(&self) -> bool

Returns the value of is_null, or the default value if is_null is unset.

impl Metric

pub fn new() -> Self

pub fn set_name(&mut self, name: String) -> &mut Self

pub fn set_alias(&mut self, alias: u64) -> &mut Self

pub fn set_datatype(&mut self, datatype: DataType) -> &mut Self

pub fn set_timestamp(&mut self, timestamp: u64) -> &mut Self

pub fn set_value(&mut self, value: Value) -> &mut Self

pub fn set_null(&mut self) -> &mut Self

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 Default for Metric

fn default() -> Self

Returns the “default value” for a type.

impl Message for Metric

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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