Struct MqttClient 

pub struct MqttClient {
    pub(crate) client: AsyncClient,
    pub(crate) thing_name: String,
    pub(crate) ctx: Arc<Mutex<MqttContext>>,
}

Fields

client: AsyncClient

thing_name: String

ctx: Arc<Mutex<MqttContext>>

Implementations

impl MqttClient

pub async fn subscribe( &self, topic: impl AsRef<str>, qos: QoS, ) -> Result<Subscriber>

Subscribes to a given topic with the specified QoS level and returns a Subscriber.

Arguments

• topic: A string slice representing the topic to subscribe to.
• qos: The Quality of Service level for the subscription.

Returns

A Result containing a Subscriber if the subscription is successful, otherwise an Error.

pub async fn subscribe_owned( &self, topic: impl AsRef<str>, qos: QoS, ) -> Result<OwnedSubscriber>

Subscribes to a given MQTT topic with the specified Quality of Service QoS level and returns an OwnedSubscriber that can be used to receive published messages.

Arguments

• topic: A string slice representing the topic to subscribe to.
• qos: The Quality of Service level for the subscription.

Returns

A Result containing an OwnedSubscriber if the subscription is successful, otherwise an Error.

pub async fn subscribe_many<Iter>( &self, topics: Iter, qos: QoS, ) -> Result<Subscriber>

where Iter: IntoIterator, Iter::Item: AsRef<str>,

Subscribes to multiple MQTT topics with the specified Quality of Service (QoS) level and returns a Subscriber that can be used to receive published messages.

Arguments

• topics: An iterator of topic strings to subscribe to.
• qos: The Quality of Service level for the subscriptions.

Returns

A Result containing a Subscriber if the subscriptions are successful, otherwise an Error.

pub async fn subscribe_many_owned<Iter>( &self, topics: Iter, qos: QoS, ) -> Result<OwnedSubscriber>

where Iter: IntoIterator, Iter::Item: AsRef<str>,

Subscribes to multiple MQTT topics with the specified Quality of Service QoS level and returns an OwnedSubscriber that can be used to receive published messages.

Arguments

• topics: An iterator of topic strings to subscribe to.
• qos: The Quality of Service level for the subscriptions.

Returns

A Result containing an OwnedSubscriber if the subscriptions are successful, otherwise an Error.

pub async fn publish( &self, topic: impl AsRef<str>, qos: QoS, retain: bool, payload: Bytes, ) -> Result<()>

Publishes a message to the MQTT broker.

Arguments

• topic: The topic to publish the message to.
• qos: The Quality of Service level for the publication.
• retain: Whether the message should be retained by the broker.
• payload: The message payload to publish.

Returns

A Result indicating whether the publication was successful.

pub async fn unsubscribe(&self, topic: impl AsRef<str>) -> Result<()>

Unsubscribes from a given topic.

Arguments

• topic: The topic to unsubscribe from.

Returns

A Result indicating whether the unsubscription was successful.

pub fn schedule_unsubscribe(&self, topic: impl AsRef<str>)

Schedules unsubscription from a single MQTT topic.

This method schedules unsubscription from the provided topic. The actual unsubscription will happen at a later time.

Arguments

• topic - The topic name to unsubscribe from.

pub async fn unsubscribe_many<Iter>(&self, topics: Iter) -> Result<()>

where Iter: IntoIterator, Iter::Item: AsRef<str>,

Unsubscribes the client from multiple MQTT topics. If any unsubscribe operation fails, the function returns an error.

Arguments

• topics - An iterator of topic strings to unsubscribe from.

Returns

A Result indicating whether the unsubscribe operation was successful.

pub fn schedule_unsubscribe_many<Iter>(&self, topics: Iter)

where Iter: IntoIterator, Iter::Item: AsRef<str>,

Schedules unsubscription from multiple topics.

This method schedules unsubscription from the provided topics. The actual unsubscription will happen at a later time

Arguments

• topics - An iterator of topic names to unsubscribe from.

pub fn thing_name(&self) -> &str

Returns the name of the thing associated with this MqttClient.

Trait Implementations

impl Clone for MqttClient

fn clone(&self) -> MqttClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttClient

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

Formats the value using the given formatter.