Struct WillProperties 

pub struct WillProperties<'a> {
    pub payload_format_indicator: Option<u8>,
    pub message_expiry_interval: Option<u32>,
    pub content_type: Option<&'a str>,
    pub response_topic: Option<&'a str>,
    pub correlation_data: Option<&'a [u8]>,
    pub delay_interval: Option<u32>,
    pub user_properties: Vec<(&'a str, &'a str), 32>,
}

The Will Properties field defines the Application Message properties to be sent with the Will Message when it is published, and properties which define when to publish the Will Message.

MQTT5 SPECIFICATION

Fields

payload_format_indicator: Option<u8>

1 (0x01) Byte, Identifier of the Payload Format Indicator.

Followed by the value of the Payload Format Indicator, either of:

• 0 (0x00) Byte Indicates that the Will Message is unspecified bytes, which is equivalent to not sending a Payload Format Indicator.
• 1 (0x01) Byte Indicates that the Will Message is UTF-8 Encoded Character Data.

message_expiry_interval: Option<u32>

2 (0x02) Byte, Identifier of the Message Expiry Interval.

Followed by the Four Byte Integer representing the Message Expiry Interval.

content_type: Option<&'a str>

3 (0x03) Identifier of the Content Type.

Followed by a UTF-8 Encoded String describing the content of the Will Message.

response_topic: Option<&'a str>

8 (0x08) Byte, Identifier of the Response Topic.

Followed by a UTF-8 Encoded String which is used as the Topic Name for a response message.

correlation_data: Option<&'a [u8]>

9 (0x09) Byte, Identifier of the Correlation Data.

Followed by Binary Data. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received.

delay_interval: Option<u32>

24 (0x18) Byte, Identifier of the Will Delay Interval.

Followed by the Four Byte Integer representing the Will Delay Interval in seconds.

user_properties: Vec<(&'a str, &'a str), 32>

38 (0x26) Byte, Identifier of the User Property.

Followed by a UTF-8 String Pair.

Implementations

impl<'a> WillProperties<'a>

pub fn read( buf: &'a [u8], offset: &mut usize, ) -> Result<Option<Self>, MqttError>

pub fn write(&self, buf: &mut [u8], offset: &mut usize) -> Result<(), MqttError>

Trait Implementations

impl<'a> Clone for WillProperties<'a>

fn clone(&self) -> WillProperties<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WillProperties<'a>

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

Formats the value using the given formatter.

impl<'a> Default for WillProperties<'a>

fn default() -> WillProperties<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for WillProperties<'a>

fn eq(&self, other: &WillProperties<'a>) -> 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<'a> StructuralPartialEq for WillProperties<'a>