Struct paho_mqtt::topic_matcher::TopicMatcher

pub struct TopicMatcher<T: Default> { /* private fields */ }

A collection of topic filters to arbitrary objects.

This can be used to get an iterator to all items that have a filter that matches a topic. To test against a single filter, see TopicFilter. This collection is more commonly used when there are a nuber of filters and each needs to be associated with a particular action or piece of data. Note, though, that a single incoming topic could match against several items in the collection. For example, the topic: data/temperature/engine

Could match against the filters: data/temperature/# data/+/engine

Thus, the collection gives an iterator for the items matching a topic.

A common use for this would be to store callbacks to proces incoming messages based on topics.

This code was adapted from the Eclipse Python MQTTMatcher class: https://github.com/eclipse/paho.mqtt.python/blob/master/src/paho/mqtt/matcher.py

which use a prefix tree (trie) to store the values.

Implementations

impl<T: Default> TopicMatcher<T>

pub fn new() -> Self

Creates a new topic matcher collection.

pub fn insert(&mut self, key: &str, val: T)

Inserts a new topic filter into the collection.

pub fn get(&self, key: &str) -> Option<&T>

Gets a value from the collection using an exact filter match.

pub fn matches<'a, 'b>(&'a self, topic: &'b str) -> Iter<'a, 'b, T>

Gets an iterator for all the matches to the specified

pub fn has_match(&self, topic: &str) -> bool

Determines if the topic matches any of the filters in the collection.

Trait Implementations

impl<T: Default + Default> Default for TopicMatcher<T>

fn default() -> TopicMatcher<T>

Returns the “default value” for a type.