Struct PublishPacket 

pub struct PublishPacket {
    pub topic_name: String,
    pub packet_id: Option<u16>,
    pub payload: Vec<u8>,
    pub qos: QoS,
    pub retain: bool,
    pub dup: bool,
    pub properties: Properties,
    pub protocol_version: u8,
}

MQTT PUBLISH packet

Fields

topic_name: String

Topic name

packet_id: Option<u16>

Packet identifier (required for QoS > 0)

payload: Vec<u8>

Message payload

qos: QoS

Quality of Service level

retain: bool

Retain flag

dup: bool

Duplicate delivery flag

properties: Properties

PUBLISH properties (v5.0 only)

protocol_version: u8

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

Implementations

impl PublishPacket

pub fn new( topic_name: impl Into<String>, payload: impl Into<Vec<u8>>, qos: QoS, ) -> Self

Creates a new PUBLISH packet (v5.0)

pub fn new_v311( topic_name: impl Into<String>, payload: impl Into<Vec<u8>>, qos: QoS, ) -> Self

Creates a new PUBLISH packet for v3.1.1

pub fn with_packet_id(self, id: u16) -> Self

Sets the packet identifier

pub fn with_retain(self, retain: bool) -> Self

Sets the retain flag

pub fn with_dup(self, dup: bool) -> Self

Sets the duplicate flag

pub fn with_payload_format_indicator(self, is_utf8: bool) -> Self

Sets the payload format indicator

pub fn with_message_expiry_interval(self, seconds: u32) -> Self

Sets the message expiry interval

pub fn with_topic_alias(self, alias: u16) -> Self

Sets the topic alias

pub fn with_response_topic(self, topic: String) -> Self

Sets the response topic

pub fn with_correlation_data(self, data: Vec<u8>) -> Self

Sets the correlation data

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

Adds a user property

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

Adds a subscription identifier

pub fn with_content_type(self, content_type: String) -> Self

Sets the content type

pub fn topic_alias(&self) -> Option<u16>

Gets the topic alias from properties

pub fn message_expiry_interval(&self) -> Option<u32>

Gets the message expiry interval from properties

impl PublishPacket

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 PublishPacket

fn clone(&self) -> PublishPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishPacket

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

Formats the value using the given formatter.

impl From<PublishPacket> for Message

fn from(packet: PublishPacket) -> Self

Converts to this type from the input type.

impl MqttPacket for PublishPacket

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)