Struct minimq::publication::Publication

pub struct Publication<'a, P: ToPayload> { /* private fields */ }

Builder pattern for generating MQTT publications.

Note

By default, messages are constructed with:

• A QoS setting of QoS::AtMostOnce
• No properties
• No destination topic
• Retention set to Retain::NotRetained

It is expected that the user provide a topic either by directly specifying a publication topic in Publication::topic, or by parsing a topic from the Property::ResponseTopic property contained within received properties by using the Publication::reply API.

Implementations

impl<'a, P: ToPayload> Publication<'a, P>

pub fn new(payload: P) -> Self

Construct a new publication with a payload.

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

Specify the QoS of the publication. By default, the QoS is set to QoS::AtMostOnce.

pub fn retain(self) -> Self

Specify that this message should be Retain::Retained.

pub fn topic(self, topic: &'a str) -> Self

Specify the publication topic for this message.

Note

If this is called after Publication::reply determines a response topic, the response topic will be overridden.

pub fn properties(self, properties: &'a [Property<'a>]) -> Self

Specify properties associated with this publication.

pub fn reply(self, received_properties: &'a Properties<'a>) -> Self

Generate the publication as a reply to some other received message.

Note

The received message properties are parsed for both Property::CorrelationData and Property::ResponseTopic.

• If correlation data is found, it is automatically appended to the publication properties.

• If a response topic is identified, the message topic will be configured for it, which will override any previously-specified topic.

pub fn correlate(self, data: &'a [u8]) -> Self

Include correlation data to the message

Note

This will override any existing correlation data in the message.

Args

• data - The data composing the correlation data.

pub fn finish(self) -> Result<Pub<'a, P>, ProtocolError>

Generate the final publication.

Returns

The message to be published if a publication topic was specified. If no publication topic was identified, an error is returned.