Struct mqtt::topic_filter::TopicFilter

pub struct TopicFilter(_);

Topic filter

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

use mqtt::{TopicFilter, TopicNameRef};

let topic_filter = TopicFilter::new("sport/+/player1").unwrap();
let matcher = topic_filter.get_matcher();
assert!(matcher.is_match(TopicNameRef::new("sport/abc/player1").unwrap()));

Implementations

impl TopicFilter

pub fn new<S: Into<String>>(topic: S) -> Result<TopicFilter, TopicFilterError>

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

pub unsafe fn new_unchecked<S: Into<String>>(topic: S) -> TopicFilter

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

Methods from Deref<Target = TopicFilterRef>

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

Get a matcher

Trait Implementations

impl Clone for TopicFilter

fn clone(&self) -> TopicFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicFilter

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

Formats the value using the given formatter.

impl Decodable for TopicFilter

type Err = TopicFilterError

type Cond = ()

fn decode_with<R: Read>(
    reader: &mut R,
    _rest: Option<()>
) -> Result<TopicFilter, TopicFilterError>

Decodes object with additional data (or hints)

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

Decodes object from reader

impl Deref for TopicFilter

type Target = TopicFilterRef

The resulting type after dereferencing.

fn deref(&self) -> &TopicFilterRef

Dereferences the value.

impl Encodable for TopicFilter

type Err = TopicFilterError

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

Encodes to writer

fn encoded_length(&self) -> u32

Length of bytes after encoded

impl Eq for TopicFilter

impl From<TopicFilter> for String

fn from(topic: TopicFilter) -> String

Performs the conversion.

impl Hash for TopicFilter

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 TopicFilter

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<TopicFilter> for TopicFilter

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

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

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

This method tests for !=.

impl PartialOrd<TopicFilter> for TopicFilter

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for TopicFilter

impl StructuralPartialEq for TopicFilter