Struct Subscribe 

pub struct Subscribe { /* private fields */ }

Represents an MQTT v5 Subscribe packet

Used to request subscription to one or more topics with various options:

• QoS levels
• Retain handling preferences
• Local message filtering

Example

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

let subscribe = Subscribe::new(
    1234,
    None,
    vec![
        TopicOptionFilter::new(
            "sensors/temperature",
            QoS::AtLeastOnce,
            false,
            true,
            RetainHandling::Send
        ),
        TopicOptionFilter::new(
            "control/#",
            QoS::ExactlyOnce,
            true,
            false,
            RetainHandling::SendForNewSub
        )
    ]
);

let filters = subscribe.filters();
assert_eq!(filters[0],
           TopicOptionFilter::new(
                            "sensors/temperature",
                            QoS::AtLeastOnce,
                            false,
                            true,
                            RetainHandling::Send
                        ));

Implementations

impl Subscribe

pub fn new<T: IntoIterator<Item = TopicOptionFilter>>( packet_id: u16, properties: Option<SubscribeProperties>, filters: T, ) -> Self

Creates a new Subscribe packet

pub fn packet_id(&self) -> u16

Returns the packet identifier

pub fn properties(&self) -> Option<SubscribeProperties>

Returns the subscription properties

pub fn filters(&self) -> TopicOptionFilters

Returns the collection of topic filters

Trait Implementations

impl Clone for Subscribe

fn clone(&self) -> Subscribe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscribe

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

Formats the value using the given formatter.

impl Decode for Subscribe

fn decode(packet: RawPacket) -> Result<Self, Error>

Decodes a Subscribe packet from raw bytes

impl Encode for Subscribe

fn encode(&self, buf: &mut BytesMut) -> Result<(), Error>

Encodes the Subscribe packet into a byte buffer

fn payload_len(&self) -> usize

Calculates the total packet length

impl From<Subscribe> for Packet

fn from(value: Subscribe) -> Self

Converts to this type from the input type.

impl PartialEq for Subscribe

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

impl StructuralPartialEq for Subscribe

impl Subscribe for Subscribe