Enum SparkplugTopic 

pub enum SparkplugTopic {
    Node {
        group: GroupId,
        edge: EdgeNodeId,
        ty: MessageType,
    },
    Device {
        group: GroupId,
        edge: EdgeNodeId,
        device: DeviceId,
        ty: MessageType,
    },
    HostState {
        host_id: String,
    },
}

A parsed Sparkplug B topic.

Variants

Node

An Edge-Node-level topic (4 tokens; N* message types).

Fields

group: GroupId

Group ID.

edge: EdgeNodeId

Edge Node ID.

ty: MessageType

Message type (one of NBIRTH/NDEATH/NDATA/NCMD).

Device

A Device-level topic (5 tokens; D* message types).

Fields

group: GroupId

Group ID.

edge: EdgeNodeId

Edge Node ID.

device: DeviceId

Device ID.

ty: MessageType

Message type (one of DBIRTH/DDEATH/DDATA/DCMD).

HostState

A Host Application STATE topic (spBv1.0/STATE/<host_id>).

Fields

host_id: String

Host Application ID.

Implementations

impl SparkplugTopic

pub fn node(group: GroupId, edge: EdgeNodeId, ty: MessageType) -> Result<Self>

Build an Edge-Node topic; the message type must be a non-device N* type.

Errors

Returns SparkplugError::InvalidTopic if ty is a device or STATE type.

pub fn device( group: GroupId, edge: EdgeNodeId, device: DeviceId, ty: MessageType, ) -> Result<Self>

Build a Device topic; the message type must be a D* type.

Errors

Returns SparkplugError::InvalidTopic if ty is not a device type.

pub fn message_type(&self) -> MessageType

The message type of this topic.

pub fn parse(topic: &str) -> Result<Self>

Parse a topic string into a validated SparkplugTopic.

Errors

Returns SparkplugError::InvalidTopic / SparkplugError::InvalidId for a bad namespace, wrong token count, reserved characters, or a message type that does not match the topic arity.

Trait Implementations

impl Clone for SparkplugTopic

fn clone(&self) -> SparkplugTopic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparkplugTopic

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

Formats the value using the given formatter.

impl Display for SparkplugTopic

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

Formats the value using the given formatter.

impl Eq for SparkplugTopic

impl PartialEq for SparkplugTopic

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