Struct TopicFilter

pub struct TopicFilter { /* private fields */ }

Represents an MQTT topic filter

Implementations

impl TopicFilter

pub fn from_string(topic_filter: String) -> Result<TopicFilter, TopicParseError>

Create a new TopicFilter from a String

Arguments

• topic_filter - The MQTT topic filter

Errors

TopicParseError - If the topic filter is invalid for an MQTT topic filter

pub fn as_str(&self) -> &str

Get the TopicFilter formatted as a &str

pub fn matches_topic_name(&self, topic_name: &TopicName) -> bool

Check if the TopicFilter matches given TopicName

Arguments

• topic_name - The MQTT topic name to match against

pub fn is_valid_topic_filter(topic_filter: &str) -> bool

Returns true if the MQTT topic filter is valid

Arguments

• topic_filter - The MQTT topic filter to check validity of

Trait Implementations

impl Clone for TopicFilter

fn clone(&self) -> TopicFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicFilter

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

Formats the value using the given formatter.

impl Display for TopicFilter

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

Formats the value using the given formatter.

impl FromStr for TopicFilter

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

Create a new TopicFilter from a &str

Arguments

• s - The MQTT topic filter

Errors

TopicParseError - If the topic filter is invalid for an MQTT topic filter

type Err = TopicParseError

The associated error which can be returned from parsing.

impl Hash for TopicFilter

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TopicFilter

fn eq(&self, other: &Self) -> 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 Eq for TopicFilter