Struct TopicName

pub struct TopicName { /* private fields */ }

Represents an MQTT topic name

Implementations

impl TopicName

pub fn from_string(topic_name: String) -> Result<TopicName, TopicParseError>

Create a new TopicName from a String

Arguments

• topic_name - The MQTT topic name

Errors

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

pub fn as_str(&self) -> &str

Get the TopicName formatted as a &str

pub fn matches_topic_filter(&self, topic_filter: &TopicFilter) -> bool

Check if the TopicName matches given TopicFilter

Arguments

• topic_filter - The MQTT topic filter to match against

pub fn is_valid_topic_name(topic_name: &str) -> bool

Returns true if the MQTT topic name is valid

Arguments

• topic_name - The MQTT topic name to check validity of

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 Display for TopicName

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

Formats the value using the given formatter.

impl FromStr for TopicName

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

Create a new TopicName from a &str

Arguments

• s - The MQTT topic name

Errors

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

type Err = TopicParseError

The associated error which can be returned from parsing.

impl Hash for TopicName

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 TopicName

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 TopicName