Struct MessageBuilder

pub struct MessageBuilder<T: PayloadSerialize> { /* private fields */ }

Builder for Message.

Implementations

impl<T: PayloadSerialize + Clone> MessageBuilder<T>

pub fn qos<VALUE: Into<QoS>>(&mut self, value: VALUE) -> &mut Self

Quality of Service of the telemetry message. Can only be AtMostOnce or AtLeastOnce.

pub fn custom_user_data<VALUE: Into<Vec<(String, String)>>>( &mut self, value: VALUE, ) -> &mut Self

User data that will be set as custom MQTT User Properties on the telemetry message. Can be used to pass additional metadata to the receiver. Default is an empty Vec.

pub fn topic_tokens<VALUE: Into<HashMap<String, String>>>( &mut self, value: VALUE, ) -> &mut Self

Topic token keys/values to be replaced into the publish topic of the telemetry message.

pub fn cloud_event<VALUE: Into<Option<CloudEvent>>>( &mut self, value: VALUE, ) -> &mut Self

Cloud event of the telemetry message.

pub fn retain<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Indicates whether the message should be retained or not.

pub fn persist<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Indicates that the telemetry event should be retained by the broker and stored to disk. Note that this is only useable with the AIO Broker and with retain enabled (which will be set by default if this option is enabled).

pub fn build(&self) -> Result<Message<T>, MessageBuilderError>

Builds a new Message.

Errors

If a required field has not been initialized.

impl<T: PayloadSerialize> MessageBuilder<T>

pub fn payload(&mut self, payload: T) -> Result<&mut Self, AIOProtocolError>

Add a payload to the telemetry message. Validates successful serialization of the payload.

Errors

AIOProtocolError of kind PayloadInvalid if serialization of the payload fails

AIOProtocolError of kind ConfigurationInvalid if the content type is not valid utf-8

pub fn message_expiry(&mut self, message_expiry: Duration) -> &mut Self

Set the message expiry for the telemetry.

Note: Will be rounded up to the nearest second.

Trait Implementations

impl<T: Clone + PayloadSerialize> Clone for MessageBuilder<T>

fn clone(&self) -> MessageBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PayloadSerialize + Clone> Default for MessageBuilder<T>

fn default() -> Self

Returns the “default value” for a type.