Struct TopicOptionFilters 

pub struct TopicOptionFilters(/* private fields */);

Collection of topic filters for a subscription

Example

use mqute_codec::protocol::v5::{Subscribe, TopicOptionFilters, TopicOptionFilter, RetainHandling};
use mqute_codec::protocol::QoS;

let filters = vec![
    TopicOptionFilter::new("topic1", QoS::AtLeastOnce, false, true, RetainHandling::DoNotSend),
    TopicOptionFilter::new("topic2", QoS::ExactlyOnce, true, true, RetainHandling::SendForNewSub),
];
let topic_filters = TopicOptionFilters::new(filters);
assert_eq!(topic_filters.len(), 2);

Implementations

impl TopicOptionFilters

pub fn new<T: IntoIterator<Item = TopicOptionFilter>>(filters: T) -> Self

Creates a new collection of topic filters

Panics

Panics if:

• No filters are provided.
• The topic filters are invalid according to MQTT topic naming rules.

pub fn len(&self) -> usize

Returns the number of topic filters in the collection.

Trait Implementations

impl AsRef<Vec<TopicOptionFilter>> for TopicOptionFilters

fn as_ref(&self) -> &Vec<TopicOptionFilter>

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

impl Borrow<Vec<TopicOptionFilter>> for TopicOptionFilters

fn borrow(&self) -> &Vec<TopicOptionFilter>

Immutably borrows from an owned value.

impl Clone for TopicOptionFilters

fn clone(&self) -> TopicOptionFilters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicOptionFilters

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

Formats the value using the given formatter.

impl Eq for TopicOptionFilters

impl From<TopicOptionFilters> for Vec<TopicOptionFilter>

fn from(value: TopicOptionFilters) -> Self

Converts to this type from the input type.

impl From<Vec<TopicOptionFilter>> for TopicOptionFilters

fn from(value: Vec<TopicOptionFilter>) -> Self

Converts to this type from the input type.

impl FromIterator<TopicOptionFilter> for TopicOptionFilters

fn from_iter<T: IntoIterator<Item = TopicOptionFilter>>(iter: T) -> Self

Creates a value from an iterator.

impl Index<usize> for TopicOptionFilters

type Output = TopicOptionFilter

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for TopicOptionFilters

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for TopicOptionFilters

type Item = TopicOptionFilter

The type of the elements being iterated over.

type IntoIter = IntoIter<TopicOptionFilter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TopicOptionFilters

fn eq(&self, other: &TopicOptionFilters) -> 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 StructuralPartialEq for TopicOptionFilters