Enum sparkplug_rs::TopicName

pub enum TopicName {
    NodeMessage {
        namespace: TopicNamespace,
        group_id: String,
        node_message_type: NodeMessageType,
        edge_node_id: String,
    },
    DeviceMessage {
        namespace: TopicNamespace,
        group_id: String,
        device_message_type: DeviceMessageType,
        edge_node_id: String,
        device_id: String,
    },
    StateMessage {
        scada_host_id: String,
    },
}

Rust representation of a sparkplug MQTT topic-name.

The TopicName can be one of three possible types:

• TopicName::NodeMessage for Edge Nodes
• TopicName::DeviceMessage for devices
• TopicName::StateMessage for SCADA applications

Examples

let node = TopicName::new_node_message(TopicNamespace::SPBV1_0,
                                       "my_group".to_string(),
                                       NodeMessageType::NBIRTH,
                                       "nodeId".to_string());
assert_eq!(node.to_string(), "spBv1.0/my_group/NBIRTH/nodeId");

let topic: TopicName = TopicName::from_str("spBv1.0/my_group/NBIRTH/nodeId").unwrap();
assert_eq!(topic, node);

let device = TopicName::new_device_message(TopicNamespace::SPBV1_0,
                                           "my_group".to_string(),
                                           DeviceMessageType::DBIRTH,
                                           "nodeId".to_string(),
                                           "deviceId".to_string());
assert_eq!(device.to_string(), "spBv1.0/my_group/DBIRTH/nodeId/deviceId");

let topic: TopicName = TopicName::from_str("spBv1.0/my_group/DBIRTH/nodeId/deviceId").unwrap();
assert_eq!(topic, device);

let state = TopicName::new_state_message("scada_host_id".to_string());
assert_eq!(state.to_string(), "STATE/scada_host_id");

let topic: TopicName = TopicName::from_str("STATE/scada_host_id").unwrap();
assert_eq!(state, topic);

Variants

NodeMessage

Fields

namespace: TopicNamespace

group_id: String

node_message_type: NodeMessageType

edge_node_id: String

A message for edge-nodes

DeviceMessage

Fields

namespace: TopicNamespace

group_id: String

device_message_type: DeviceMessageType

edge_node_id: String

device_id: String

A message for devices

StateMessage

Fields

scada_host_id: String

A state message for scada systems

Implementations

impl TopicName

pub fn new_node_message(
    namespace: TopicNamespace,
    group_id: String,
    node_message_type: NodeMessageType,
    edge_node_id: String
) -> Self

Constructs a new TopicName of type TopicName::NodeMessage

pub fn new_device_message(
    namespace: TopicNamespace,
    group_id: String,
    device_message_type: DeviceMessageType,
    edge_node_id: String,
    device_id: String
) -> Self

Constructs a new TopicName of type TopicName::DeviceMessage

pub fn new_state_message(scada_host_id: String) -> Self

Constructs a new TopicName of type TopicName::StateMessage

Trait Implementations

impl Clone for TopicName

fn clone(&self) -> TopicName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicName

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

Formats the value using the given formatter.

impl FromStr for TopicName

type Err = Box<dyn Error + Sync + Send + 'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<TopicName> for TopicName

fn eq(&self, other: &TopicName) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TopicName) -> bool

This method tests for !=.

impl PartialOrd<TopicName> for TopicName

fn partial_cmp(&self, other: &TopicName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToString for TopicName

fn to_string(&self) -> String

Converts the given value to a String.

impl StructuralPartialEq for TopicName