Struct Publish 

pub struct Publish { /* private fields */ }

Represents an MQTT v5 Publish packet

This is the primary structure for message publication in MQTT, supporting:

• All QoS levels (0, 1, and 2)
• Retained messages
• Duplicate delivery detection
• Extensive message properties (v5 only)

Example

use bytes::Bytes;
use mqute_codec::protocol::{Flags, QoS};
use mqute_codec::protocol::v5::{Publish, PublishProperties};

// Create a QoS 1 message with properties
let properties = PublishProperties {
    content_type: Some("text/plain".into()),
    ..Default::default()
};
let publish = Publish::new(
    "test/topic",
    1234,
    Some(properties.clone()),
    Bytes::from("message payload"),
    Flags::new(QoS::AtLeastOnce)
);

assert_eq!(publish.flags(), Flags::new(QoS::AtLeastOnce));

assert_eq!(publish.packet_id(), Some(1234u16));

assert_eq!(publish.properties(), Some(properties));

Implementations

impl Publish

pub fn new<T: Into<String>>( topic: T, packet_id: u16, properties: Option<PublishProperties>, payload: Bytes, flags: Flags, ) -> Self

Creates a new Publish packet

Panics

Panics if:

• QoS > 0 but packet_id is 0.
• The topic name is invalid according to MQTT topic naming rules.

pub fn flags(&self) -> Flags

Returns the packet flags

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

Returns the packet identifier (if QoS > 0)

pub fn topic(&self) -> String

Returns the message topic

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

Returns a copy of the properties (if any)

pub fn payload(&self) -> Bytes

Returns the message payload

Trait Implementations

impl Clone for Publish

fn clone(&self) -> Publish

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Publish

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

Formats the value using the given formatter.

impl Decode for Publish

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

Decodes a Publish packet from raw bytes

impl Encode for Publish

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

Encodes the Publish packet into a byte buffer

fn payload_len(&self) -> usize

Calculates the total packet length

impl From<Publish> for Packet

fn from(value: Publish) -> Self

Converts to this type from the input type.

impl PartialEq for Publish

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

impl Publish for Publish

impl StructuralPartialEq for Publish