Struct PublishOptions 

#[non_exhaustive]
pub struct PublishOptions {
    pub content_type: Option<MqttString>,
    pub response_topic: Option<TopicBuf>,
    pub correlation_data: Option<MqttBytesBuf>,
    pub message_expiry: Option<u32>,
    pub payload_format: Option<PayloadFormat>,
    pub user_properties: Vec<(MqttString, MqttString)>,
}

MQTT v5 properties to attach to an outgoing PUBLISH.

Usually configured through the PublishBuilder fluent setters rather than constructed directly.

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.

content_type: Option<MqttString>

Content type (property 0x03).

response_topic: Option<TopicBuf>

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

correlation_data: Option<MqttBytesBuf>

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

message_expiry: Option<u32>

Message expiry interval, in seconds (property 0x02).

payload_format: Option<PayloadFormat>

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

user_properties: Vec<(MqttString, MqttString)>

User properties (property 0x26).

Implementations

impl PublishOptions

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

Iterates over the properties as Property views.

Trait Implementations

impl Clone for PublishOptions

fn clone(&self) -> PublishOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishOptions

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

Formats the value using the given formatter.

impl Default for PublishOptions

fn default() -> PublishOptions

Returns the “default value” for a type.