Struct tether_agent::plugs::definitions::InputPlugDefinition

pub struct InputPlugDefinition { /* private fields */ }

Implementations

impl InputPlugDefinition

pub fn new( name: &str, topic: TetherOrCustomTopic, qos: Option<i32> ) -> InputPlugDefinition

pub fn matches(&self, incoming_topic: &TetherOrCustomTopic) -> bool

Use the topic of an incoming message to check against the definition of an Input Plug.

Due to the use of wildcard subscriptions, multiple topic strings might match a given Input Plug definition. e.g. someRole/any/plugMessages and anotherRole/any/plugMessages should both match on an Input Plug named plugMessages unless more specific Role and/or ID parts were specified in the Input Plug Definition.

In the case where an Input Plug was defined with a completely manually-specified topic string, this function returns a warning and marks ANY incoming message as a valid match; the end-user developer is expected to match against topic strings themselves.

Trait Implementations

impl Debug for InputPlugDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputPlugDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PlugDefinitionCommon<'_> for InputPlugDefinition

fn name(&self) -> &str

fn topic_str(&self) -> &str

fn topic(&self) -> &TetherOrCustomTopic

fn qos(&self) -> i32

impl Serialize for InputPlugDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.