Struct Unsubscribe 

pub struct Unsubscribe { /* private fields */ }

Represents an MQTT v5 Unsubscribe packet

The Unsubscribe packet is sent by clients to request removal of existing subscriptions. It contains:

• Packet Identifier (for QoS 1 acknowledgment)
• List of topic filters to unsubscribe from
• Optional properties (v5 only)

Example

use mqute_codec::protocol::TopicFilters;
use mqute_codec::protocol::v5::{Unsubscribe, UnsubscribeProperties};

// Simple unsubscribe with no properties
let unsubscribe = Unsubscribe::new(
    1234,
    None,
    vec!["sensors/temperature", "control/#"]
);

assert_eq!(unsubscribe.packet_id(), 1234u16);

// Unsubscribe with properties
let properties = UnsubscribeProperties {
    user_properties: vec![("reason".into(), "client_shutdown".into())],
};
let unsubscribe = Unsubscribe::new(
    5678,
    Some(properties),
    vec!["debug/logs"]
);

assert_eq!(unsubscribe.filters(), TopicFilters::new(vec!["debug/logs"]));

Implementations

impl Unsubscribe

pub fn new<T: IntoIterator<Item: Into<String>>>( packet_id: u16, properties: Option<UnsubscribeProperties>, filters: T, ) -> Self

Creates a new Unsubscribe packet

Panics

Panics if the topic filters are invalid according to MQTT topic naming rules.

pub fn packet_id(&self) -> u16

Returns the packet identifier

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

Returns the unsubscribe properties

pub fn filters(&self) -> TopicFilters

Returns the topic filters to unsubscribe from

Trait Implementations

impl Clone for Unsubscribe

fn clone(&self) -> Unsubscribe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Unsubscribe

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

Formats the value using the given formatter.

impl Decode for Unsubscribe

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

Decodes an Unsubscribe packet from raw bytes

impl Encode for Unsubscribe

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

Encodes the Unsubscribe packet into a byte buffer

fn payload_len(&self) -> usize

Calculates the total packet length

impl From<Unsubscribe> for Packet

fn from(value: Unsubscribe) -> Self

Converts to this type from the input type.

impl PartialEq for Unsubscribe

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

impl StructuralPartialEq for Unsubscribe

impl Unsubscribe for Unsubscribe