Struct PublishBuilder 

pub struct PublishBuilder {
    cmd_tx: Sender<Command>,
    topic: TopicBuf,
    payload: Vec<u8>,
    qos: QoS,
    retain: bool,
    properties: PublishOptions,
}

Builder for publishing a message with optional MQTT v5 properties.

Obtained via MqttClient::publish.

Call send to obtain a PublishFuture. The future is lazy: no work is done until it is polled.

Fields

cmd_tx: Sender<Command>

topic: TopicBuf

payload: Vec<u8>

qos: QoS

retain: bool

properties: PublishOptions

Implementations

impl PublishBuilder

pub(crate) fn new( cmd_tx: Sender<Command>, topic: TopicBuf, payload: Vec<u8>, qos: QoS, ) -> Self

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

Sets the retain flag.

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

Sets the MIME content type (property 0x03).

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

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

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

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

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

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

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

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

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

Adds a user property key-value pair (property 0x26). May be called multiple times.

pub fn send(self) -> PublishFuture

Returns a lazy future representing the publish.

No work is done until the future is polled. Awaiting it drives the publish to broker acknowledgement (PUBACK for QoS 1, PUBCOMP for QoS 2). For QoS 0 it resolves once the bytes have been written.

Call PublishFuture::queued on the returned future if you only need to wait for the message to be persisted locally.