Struct Will

pub struct Will {
    pub properties: Option<WillProperties>,
    pub topic: String,
    pub payload: Bytes,
    pub qos: QoS,
    pub retain: bool,
}

Represents a Will message in MQTT v5.

The Will message is published by the broker when the client disconnects unexpectedly. It includes the message content, delivery options, and properties.

Example

use mqute_codec::protocol::v5::Will;
use bytes::Bytes;
use mqute_codec::protocol::QoS;

let will = Will::new(None, "tpoic", Bytes::new(), QoS::ExactlyOnce, false);

Fields

properties: Option<WillProperties>

Will message properties

topic: String

Topic name to publish the Will message to

payload: Bytes

Will message payload

qos: QoS

Quality of Service level for the Will message

retain: bool

Whether the Will message should be retained

Implementations

impl Will

pub fn new<T: Into<String>>( properties: Option<WillProperties>, topic: T, payload: Bytes, qos: QoS, retain: bool, ) -> Will

Creates a new Will packet

Trait Implementations

impl Clone for Will

fn clone(&self) -> Will

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Will

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

Formats the value using the given formatter.

impl PartialEq for Will

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

impl StructuralPartialEq for Will