Struct Message

pub struct Message { /* private fields */ }

A Message represents all the information passed in an MQTT PUBLISH packet. This is the primary data transfer mechanism.

Implementations

impl Message

pub fn new<S, V, Q>(topic: S, payload: V, qos: Q) -> Self

where S: Into<String>, V: Into<Vec<u8>>, Q: Into<QoS>,

Creates a new message.

Arguments

• topic The topic on which the message is published.
• payload The binary payload of the message
• qos The quality of service for message delivery (0, 1, or 2)

pub fn new_retained<S, V, Q>(topic: S, payload: V, qos: Q) -> Self

where S: Into<String>, V: Into<Vec<u8>>, Q: Into<QoS>,

Creates a new message that will be retained by the broker. This creates a message with the ‘retained’ flag set.

Arguments

• topic The topic on which the message is published.
• payload The binary payload of the message
• qos The quality of service for message delivery (0, 1, or 2)

pub fn topic(&self) -> &str

Gets the topic for the message.

pub fn payload(&self) -> &[u8]

Gets the payload of the message. This returns the payload as a slice.

pub fn payload_str(&self) -> Cow<'_, str>

Gets the payload of the message as a string.

This utilizes the “lossy” style of conversion from the std library. If the contents of the CStr are valid UTF-8 data, this function will return a Cow::Borrowed(&str) with the the corresponding &str slice. Otherwise, it will replace any invalid UTF-8 sequences with U+FFFD REPLACEMENT CHARACTER and return a Cow::Owned(String) with the result.

pub fn qos(&self) -> QoS

Returns the Quality of Service (QOS) for the message.

pub fn retained(&self) -> bool

Gets the ‘retain’ flag for the message.

pub fn properties(&self) -> &Properties

Gets the properties in the message

Trait Implementations

impl Clone for Message

fn clone(&self) -> Self

Create a clone of the message

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Creates a default, empty message

impl Display for Message

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

Formats the message for display

impl<'a, 'b> From<(&'a str, &'b [u8])> for Message

fn from((topic, payload): (&'a str, &'b [u8])) -> Self

Converts to this type from the input type.

impl<'a, 'b> From<(&'a str, &'b [u8], i32, bool)> for Message

fn from((topic, payload, qos, retained): (&'a str, &'b [u8], i32, bool)) -> Self

Converts to this type from the input type.

impl From<DeliveryToken> for Message

fn from(v: DeliveryToken) -> Message

Converts to this type from the input type.

impl From<Message> for WillOptions

fn from(msg: Message) -> Self

Create WillOptions from a Message

impl Send for Message

impl Sync for Message