Struct mqtt::topic_name::TopicName

pub struct TopicName(_);

Topic name

http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718106

Implementations

impl TopicName

pub fn new<S: Into<String>>(topic_name: S) -> Result<TopicName, TopicNameError>

Creates a new topic name from string Return error if the string is not a valid topic name

pub unsafe fn new_unchecked(topic_name: String) -> TopicName

Creates a new topic name from string without validation

Safety

Topic names' syntax is defined in MQTT specification. Creating a name from raw string may cause errors

Methods from Deref<Target = TopicNameRef>

pub fn is_server_specific(&self) -> bool

Check if this topic name is only for server.

Topic names that beginning with a '$' character are reserved for servers

Trait Implementations

impl Clone for TopicName

pub fn clone(&self) -> TopicName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicName

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

Formats the value using the given formatter.

impl Decodable for TopicName

type Err = TopicNameError

type Cond = ()

pub fn decode_with<R: Read>(
    reader: &mut R,
    _rest: Option<()>
) -> Result<TopicName, TopicNameError>

Decodes object with additional data (or hints)

pub fn decode<R: Read>(reader: &mut R) -> Result<Self, Self::Err>

Decodes object from reader

impl Deref for TopicName

type Target = TopicNameRef

The resulting type after dereferencing.

pub fn deref(&self) -> &TopicNameRef

Dereferences the value.

impl Encodable for TopicName

type Err = TopicNameError

pub fn encode<W: Write>(&self, writer: &mut W) -> Result<(), TopicNameError>

Encodes to writer

pub fn encoded_length(&self) -> u32

Length of bytes after encoded

impl Eq for TopicName

impl From<TopicName> for String

pub fn from(topic_name: TopicName) -> String

Performs the conversion.

impl Hash for TopicName

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<TopicName> for TopicNameHeader

pub fn into(self) -> TopicName

Performs the conversion.

impl Ord for TopicName

pub fn cmp(&self, other: &TopicName) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TopicName> for TopicName

pub fn eq(&self, other: &TopicName) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &TopicName) -> bool

This method tests for !=.

impl PartialOrd<TopicName> for TopicName

pub fn partial_cmp(&self, other: &TopicName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &TopicName) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &TopicName) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &TopicName) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &TopicName) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for TopicName

impl StructuralPartialEq for TopicName