Struct Will

pub struct Will {
    pub topic: String,
    pub payload: Bytes,
    pub qos: QoS,
    pub retain: bool,
}

Represents the Last Will and Testament (LWT) feature in MQTT.

The Will struct includes the topic, payload, QoS level, and retain flag for the LWT message.

Example

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

let will = Will::new("topic", Bytes::from("message"), QoS::AtLeastOnce, true);
assert_eq!(will.topic, "topic");
assert_eq!(will.payload, Bytes::from("message"));
assert_eq!(will.qos, QoS::AtLeastOnce);
assert_eq!(will.retain, true);

Fields

topic: String

The topic to which the LWT message will be published.

payload: Bytes

The payload of the LWT message.

qos: QoS

The QoS level for the LWT message.

retain: bool

Whether the LWT message should be retained by the broker.

Implementations

impl Will

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

Creates a new Will instance.

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