Struct SubscribePacket 

pub struct SubscribePacket {
    pub packet_id: u16,
    pub filters: Vec<TopicFilter>,
    pub properties: Properties,
    pub protocol_version: u8,
}

MQTT SUBSCRIBE packet

Fields

packet_id: u16

Packet identifier

filters: Vec<TopicFilter>

Topic filters to subscribe to

properties: Properties

SUBSCRIBE properties (v5.0 only)

protocol_version: u8

Protocol version (4 = v3.1.1, 5 = v5.0)

Implementations

impl SubscribePacket

pub fn new(packet_id: u16) -> Self

Creates a new SUBSCRIBE packet (v5.0)

pub fn new_v311(packet_id: u16) -> Self

Creates a new SUBSCRIBE packet for v3.1.1

pub fn add_filter(self, filter: impl Into<String>, qos: QoS) -> Self

Adds a topic filter

pub fn add_filter_with_options(self, filter: TopicFilter) -> Self

Adds a topic filter with options

pub fn with_subscription_identifier(self, id: u32) -> Self

Sets the subscription identifier

pub fn with_user_property(self, key: String, value: String) -> Self

Adds a user property

impl SubscribePacket

pub fn decode_body_with_version<B: Buf>( buf: &mut B, fixed_header: &FixedHeader, protocol_version: u8, ) -> Result<Self>

Decodes the packet body with a specific protocol version

Errors

Returns an error if decoding fails

Trait Implementations

impl Clone for SubscribePacket

fn clone(&self) -> SubscribePacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscribePacket

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

Formats the value using the given formatter.

impl MqttPacket for SubscribePacket

fn packet_type(&self) -> PacketType

Returns the packet type

fn flags(&self) -> u8

Returns the fixed header flags

fn encode_body<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes the packet body (without fixed header)

fn decode_body<B: Buf>(buf: &mut B, fixed_header: &FixedHeader) -> Result<Self>

Decodes the packet body (without fixed header)

fn encode<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes the complete packet (with fixed header)