Struct mqtt::topic_filter::TopicFilterRef

pub struct TopicFilterRef(_);

Reference to a TopicFilter

Implementations

impl TopicFilterRef

pub fn new<S: AsRef<str> + ?Sized>(
    topic: &S
) -> Result<&TopicFilterRef, TopicFilterError>

Creates a new topic filter from string Return error if it is not a valid topic filter

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

Creates a new topic filter from string without validation

Safety

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

pub fn get_matcher(&self) -> TopicFilterMatcher<'_>

Get a matcher

Trait Implementations

impl Debug for TopicFilterRef

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

Formats the value using the given formatter.

impl Deref for TopicFilterRef

type Target = str

The resulting type after dereferencing.

pub fn deref(&self) -> &str

Dereferences the value.

impl Eq for TopicFilterRef

impl Hash for TopicFilterRef

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 Ord for TopicFilterRef

pub fn cmp(&self, other: &TopicFilterRef) -> 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<TopicFilterRef> for TopicFilterRef

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

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

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

This method tests for !=.

impl PartialOrd<TopicFilterRef> for TopicFilterRef

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for TopicFilterRef

impl StructuralPartialEq for TopicFilterRef