Struct TopicName 

pub struct TopicName<'t>(/* private fields */);

A topic name string for that messages can be published on according to https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901241. Cannot contain wildcard characters.

Examples:

• “sport/tennis/player1”
• “sport/tennis/player1/ranking”
• “sport/tennis/player1/score/wimbledon”

Implementations

impl<'t> TopicName<'t>

pub fn new(string: MqttString<'t>) -> Option<Self>

Creates a new topic name while checking for correct syntax of the topic name string.

pub const fn new_unchecked(string: MqttString<'t>) -> Self

Creates a new topic name without checking for correct syntax of the topic name string.

Invariants

The syntax of the topic name is valid. For a fallible version, use TopicName::new

Panics

In debug builds, this function will panic if the syntax of string is incorrect.

pub const fn as_borrowed(&'t self) -> Self

Delegates to crate::Bytes::as_borrowed.

Trait Implementations

impl<'t> AsRef<MqttString<'t>> for TopicName<'t>

fn as_ref(&self) -> &MqttString<'t>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'t> Clone for TopicName<'t>

fn clone(&self) -> TopicName<'t>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'t> Debug for TopicName<'t>

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

Formats the value using the given formatter.

impl<'t> From<TopicName<'t>> for MqttString<'t>

fn from(value: TopicName<'t>) -> Self

Converts to this type from the input type.

impl<'t> From<TopicName<'t>> for TopicFilter<'t>

fn from(value: TopicName<'t>) -> Self

Converts to this type from the input type.

impl<'t> PartialEq for TopicName<'t>

fn eq(&self, other: &TopicName<'t>) -> 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<'t> Eq for TopicName<'t>

impl<'t> StructuralPartialEq for TopicName<'t>