Struct WillOptions 

#[non_exhaustive]
pub struct WillOptions {
    pub topic: TopicBuf,
    pub payload: MqttBytesBuf,
    pub qos: QoS,
    pub retain: bool,
    pub delay_interval: Option<u32>,
    pub message_expiry: Option<u32>,
    pub content_type: Option<MqttString>,
    pub response_topic: Option<TopicBuf>,
    pub correlation_data: Option<MqttBytesBuf>,
    pub payload_format: Option<PayloadFormat>,
    pub user_properties: Vec<(MqttString, MqttString)>,
}

Configuration for the MQTT will message (Last Will and Testament).

If set, the broker publishes this message when the client disconnects ungracefully.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

topic: TopicBuf

Topic to publish the will message on.

payload: MqttBytesBuf

Will message payload.

qos: QoS

Quality of Service for the will message.

retain: bool

Whether the will message should be retained.

delay_interval: Option<u32>

Will delay interval in seconds (property 0x18). Delays publishing the will after disconnect.

message_expiry: Option<u32>

Message expiry interval in seconds (property 0x02).

content_type: Option<MqttString>

Content type (property 0x03).

response_topic: Option<TopicBuf>

Response topic for request/response (property 0x08).

correlation_data: Option<MqttBytesBuf>

Correlation data for request/response (property 0x09).

payload_format: Option<PayloadFormat>

Whether the payload is UTF-8 encoded (property 0x01).

user_properties: Vec<(MqttString, MqttString)>

User properties (property 0x26).

Implementations

impl WillOptions

pub const fn new(topic: TopicBuf, payload: MqttBytesBuf) -> Self

Creates a will message with a topic and payload.

pub const fn qos(self, qos: QoS) -> Self

Sets the Quality of Service for the will message.

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

Sets the retain flag for the will message.

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

Sets the will delay interval in seconds (property 0x18).

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

Sets the message expiry interval in seconds (property 0x02).

pub fn content_type(self, ct: MqttString) -> Self

Sets the content type (property 0x03).

pub fn response_topic(self, topic: TopicBuf) -> Self

Sets the response topic (property 0x08).

pub fn correlation_data(self, data: MqttBytesBuf) -> Self

Sets correlation data (property 0x09).

pub const fn payload_format(self, format: PayloadFormat) -> Self

Sets the payload format indicator (property 0x01).

pub fn user_property(self, key: MqttString, value: MqttString) -> Self

Adds a user property (property 0x26). May be called multiple times.

fn iter_properties(&self) -> impl Iterator<Item = Property<'_>>

pub(crate) fn to_properties( &self, ) -> Result<WillPropertiesBuf, PropertiesBufError>