Struct MqttTopic 

pub struct MqttTopic { /* private fields */ }

A subscription descriptor for one MQTT topic filter.

Implements SubscriptionSource, so it can sit inline in the #[subscriber(..)] decorator:

use ruststream_rumqttc::{MqttTopic, Qos};

let source = MqttTopic::new("devices/+/telemetry")
    .qos(Qos::AtLeastOnce)
    .shared("workers");

Implementations

impl MqttTopic

pub fn new(filter: impl Into<String>) -> Self

Names the topic filter, with wildcards as the protocol defines them.

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

Sets the delivery quality of service. Defaults to Qos::AtLeastOnce.

pub fn shared(self, group: impl Into<String>) -> Self

Makes this an MQTT 5 shared subscription in group: the broker distributes matching messages across the group’s consumers instead of fanning out to each.

pub fn filter(&self) -> &str

The plain topic filter (without any share group).

Trait Implementations

impl Clone for MqttTopic

fn clone(&self) -> MqttTopic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttTopic

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

Formats the value using the given formatter.

impl Eq for MqttTopic

impl PartialEq for MqttTopic

fn eq(&self, other: &MqttTopic) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MqttTopic

impl SubscriptionSource<ConnectedMqttBroker> for MqttTopic

type Subscriber = MqttSubscriber

The subscriber type this source opens.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedMqttBroker, ) -> Result<MqttSubscriber, MqttError>

Opens the subscription against the connected broker. Called once at startup.