Struct TopicFilter 

#[repr(transparent)]
pub struct TopicFilter<S: ?Sized>(S);

A MQTT topic filter.

This type works as a wrapper around any AsRef<str> type. Typically used as either a reference (TopicFilter<str>) or an owned string (TopicFilter<Box<str>>).

All the interesting methods are implemented on the TopicFilter<str> variant, but other types automatically deref to it.

Tuple Fields

0: S

Implementations

impl TopicFilter<str>

pub const fn new_ref(filter: &str) -> &Self

Creates a new topic filter reference.

pub fn to_boxed_str(&self) -> TopicFilter<Box<str>>

Converts the topic filter reference into an owned version.

pub fn contains_wildcard(&self) -> bool

Returns true if the topic filter contains any wildcard characters.

pub fn matches(&self, topic: &str) -> bool

Checks if the topic filter matches the given topic.

impl TopicFilter<Box<str>>

pub const fn to_ref(&self) -> &TopicFilter<str>

Converts the owned topic filter into a reference.

impl<S: AsRef<str>> TopicFilter<S>

pub fn new(inner: S) -> Self

Creates a new topic filter wrapping the given inner type.

pub fn into_inner(self) -> S

Consumes the topic filter and returns the inner type.

impl<S: ?Sized + AsRef<str>> TopicFilter<S>

pub fn as_str(&self) -> &str

Returns the topic filter as a string slice.

Trait Implementations

impl<S: ?Sized + AsRef<str>> AsRef<TopicFilter<str>> for TopicFilter<S>

fn as_ref(&self) -> &TopicFilter<str>

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

impl<S: ?Sized + AsRef<str>> AsRef<str> for TopicFilter<S>

fn as_ref(&self) -> &str

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

impl Borrow<TopicFilter<str>> for TopicFilter<Box<str>>

fn borrow(&self) -> &TopicFilter<str>

Immutably borrows from an owned value.

impl<S: ?Sized + AsRef<str>> Borrow<str> for TopicFilter<S>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<S: Clone + ?Sized> Clone for TopicFilter<S>

fn clone(&self) -> TopicFilter<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + ?Sized> Debug for TopicFilter<S>

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

Formats the value using the given formatter.

impl Deref for TopicFilter<Box<str>>

type Target = TopicFilter<str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> Ord for TopicFilter<S>

where S: ?Sized + AsRef<str>,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<Lhs, Rhs> PartialEq<TopicFilter<Rhs>> for TopicFilter<Lhs>

where Lhs: ?Sized + AsRef<str>, Rhs: ?Sized + AsRef<str>,

fn eq(&self, other: &TopicFilter<Rhs>) -> 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<Lhs, Rhs> PartialOrd<TopicFilter<Rhs>> for TopicFilter<Lhs>

where Lhs: ?Sized + AsRef<str>, Rhs: ?Sized + AsRef<str>,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<S: ?Sized + AsRef<str>> Eq for TopicFilter<S>