Struct Publish 

pub struct Publish { /* private fields */ }

Represents an MQTT Publish packet.

Example

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

let flags = Flags::new(QoS::AtLeastOnce);
let publish = Publish::new("topic", 1234, Bytes::from("message"), flags);

assert_eq!(publish.flags(), flags);
assert_eq!(publish.topic(), "topic");
assert_eq!(publish.packet_id(), Some(1234));
assert_eq!(publish.payload(), Bytes::from("message"));

Implementations

impl Publish

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

Creates a new Publish packet.

Panics

Panics if:

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

pub fn flags(&self) -> Flags

Returns the flags for the Publish packet.

The flags include QoS, retain, and duplicate delivery settings.

pub fn topic(&self) -> String

Returns the topic of the Publish packet.

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

Returns the packet ID of the Publish packet.

For QoS 0, this method returns None because no packet ID is used. For QoS 1 and 2, it returns the packet ID as Some(u16).

pub fn payload(&self) -> Bytes

Returns the payload of the Publish packet.

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 a raw MQTT packet.

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

Returns the length of the Publish packet payload.

The payload length includes the length of the Publish header and the message payload.

impl From<Publish> for Packet

fn from(value: Publish) -> Self

Converts to this type from the input type.

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