Struct Payload 

pub struct Payload {
    pub timestamp: Option<u64>,
    pub metrics: Vec<Metric>,
    pub seq: Option<u8>,
    pub uuid: Option<String>,
    pub body: Option<Bytes>,
}

A complete Sparkplug B payload (the body of an N/D BIRTH/DATA/DEATH/CMD message).

Fields

timestamp: Option<u64>

Message send time, epoch milliseconds UTC.

metrics: Vec<Metric>

The metrics carried by this payload.

seq: Option<u8>

The Sparkplug sequence number (0..=255); absent on NDEATH/NCMD/DCMD.

uuid: Option<String>

Optional schema UUID; also the SPBV1.0_COMPRESSED sentinel for the compression envelope.

body: Option<Bytes>

Optional opaque body (used by the compression envelope).

Implementations

impl Payload

pub fn new() -> Self

Create an empty payload.

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

Builder-style setter for the payload timestamp.

pub fn with_seq(self, seq: u8) -> Self

Builder-style setter for the sequence number.

pub fn with_metric(self, metric: Metric) -> Self

Append a metric, consuming and returning self for chaining.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Payload

Returns the “default value” for a type.

impl PartialEq for Payload

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