Struct TopicOptionFilter 

pub struct TopicOptionFilter {
    pub topic: String,
    pub qos: QoS,
    pub no_local: bool,
    pub retain_as_published: bool,
    pub retain_handling: RetainHandling,
}

Represents a single topic filter with subscription options

Example

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

let filter = TopicOptionFilter::new("topic1", QoS::AtLeastOnce, false, true, RetainHandling::DoNotSend);

Fields

topic: String

The topic filter to subscribe to

qos: QoS

Requested QoS level

no_local: bool

If true, messages published by this client won’t be received

retain_as_published: bool

If true, retain flag on published messages is kept as-is

retain_handling: RetainHandling

Controls how retained messages are handled

Implementations

impl TopicOptionFilter

pub fn new<S: Into<String>>( topic: S, qos: QoS, no_local: bool, retain_as_published: bool, retain_handling: RetainHandling, ) -> Self

Creates a new topic filter with options

Panics

Panics if the iterator is empty, as at least one topic filter is required.

Trait Implementations

impl Clone for TopicOptionFilter

fn clone(&self) -> TopicOptionFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicOptionFilter

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

Formats the value using the given formatter.

impl FromIterator<TopicOptionFilter> for TopicOptionFilters

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

Creates a value from an iterator.

impl PartialEq for TopicOptionFilter

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

impl StructuralPartialEq for TopicOptionFilter