Struct mqtt::topic_name::TopicNameRef

#[repr(transparent)]
pub struct TopicNameRef(_);

Reference to a topic name

Implementations

impl TopicNameRef

pub fn new<S: AsRef<str> + ?Sized>(
    topic_name: &S
) -> Result<&TopicNameRef, TopicNameError>

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

pub fn new_mut<S: AsMut<str> + ?Sized>(
    topic_name: &mut S
) -> Result<&mut TopicNameRef, TopicNameError>

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

pub unsafe fn new_unchecked<S: AsRef<str> + ?Sized>(
    topic_name: &S
) -> &TopicNameRef

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

pub unsafe fn new_mut_unchecked<S: AsMut<str> + ?Sized>(
    topic_name: &mut S
) -> &mut TopicNameRef

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

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 Borrow<TopicNameRef> for TopicName

fn borrow(&self) -> &TopicNameRef

Immutably borrows from an owned value.

impl BorrowMut<TopicNameRef> for TopicName

fn borrow_mut(&mut self) -> &mut TopicNameRef

Mutably borrows from an owned value.

impl Debug for TopicNameRef

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

Formats the value using the given formatter.

impl Deref for TopicNameRef

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Encodable for TopicNameRef

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

Encodes to writer

fn encoded_length(&self) -> u32

Length of bytes after encoded

impl Hash for TopicNameRef

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TopicNameRef

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TopicNameRef> for TopicNameRef

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

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

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

This method tests for !=.

impl PartialOrd<TopicNameRef> for TopicNameRef

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

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

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

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

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

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

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

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

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

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

impl ToOwned for TopicNameRef

type Owned = TopicName

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for TopicNameRef

impl StructuralEq for TopicNameRef

impl StructuralPartialEq for TopicNameRef