Struct PublicationOptions 

pub struct PublicationOptions<'p> {
    pub qos: QoS,
    pub retain: bool,
    pub topic: TopicReference<'p>,
    pub payload_format_indicator: Option<bool>,
    pub message_expiry_interval: Option<u32>,
    pub response_topic: Option<TopicName<'p>>,
    pub correlation_data: Option<MqttBinary<'p>>,
    pub content_type: Option<MqttString<'p>>,
}

Options for a publication.

Fields

qos: QoS

The quality of service that the message is published with to the server. The quality of service level used by the server to send this publication to subscribed clients is the minimum of this value and the quality of service value of the receiving client’s subscription.

retain: bool

Depicts the value of the retain flag in the PUBLISH packet. If set to 1, the server should retain the message on this topic. Retained messages with quality of service 0 can be discarded at any time by the server.

topic: TopicReference<'p>

The topic that the message is published on. The topic can be referenced over an existing topic alias mapping or by specifying the topic name and optionally mapping a topic alias to it.

payload_format_indicator: Option<bool>

Indicates whether the message is valid UTF-8. If None, there is no statement about the UTF-8 character of the message.

message_expiry_interval: Option<u32>

The message expiry interval in seconds of this application message. After this interval has passed, the server cannot publish this message onward to subscribers. If set to None, the message does not expire and the message expiry interval property is omitted on the network.

response_topic: Option<TopicName<'p>>

The topic on which the receiver should publish the response.

correlation_data: Option<MqttBinary<'p>>

Arbitrary binary data which the receiver should attach in the response to associate their response with this request.

content_type: Option<MqttString<'p>>

The custom content type of the message.

Implementations

impl<'p> Options<'p>

pub const fn new(topic: TopicReference<'p>) -> Options<'p>

Creates options with values coherent to the Default implementations of the fields and QoS::AtMostOnce.

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

Sets the Quality of Service level.

pub const fn at_least_once(self) -> Self

Sets the Quality of Service level to 1 (At Least Once).

pub const fn exactly_once(self) -> Self

Sets the Quality of Service level to 1 (Exactly Once).

pub const fn retain(self) -> Self

Sets the retain flag to true.

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

Sets the payload format indicator property.

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

Sets the message expiry interval in seconds.

pub fn response_topic(self, topic: TopicName<'p>) -> Self

Marks the publication as a request by setting the response topic property.

pub fn correlation_data(self, data: MqttBinary<'p>) -> Self

Sets the correlation data property in the request.

pub fn content_type(self, content_type: MqttString<'p>) -> Self

Sets the content type property.

Trait Implementations

impl<'p> Clone for Options<'p>

fn clone(&self) -> Options<'p>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'p> Debug for Options<'p>

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

Formats the value using the given formatter.