Struct MqttPublisher

Source
pub struct MqttPublisher<T, F> { /* private fields */ }
Expand description

Typed MQTT publisher for a specific topic.

Created via MqttClient::get_publisher(). Supports QoS and retain configuration.

Implementations§

Source§

impl<T, F> MqttPublisher<T, F>
where F: MessageSerializer<T>,

Source

pub fn new( client: AsyncClient, serializer: F, topic: impl Into<ArcStr>, ) -> MqttPublisher<T, F>

Internal constructor. Use MqttClient::get_publisher() instead.

Source

pub fn with_qos(self, qos: QoS) -> MqttPublisher<T, F>

Sets Quality of Service level for published messages.

Source

pub fn with_retain(self, retain: bool) -> MqttPublisher<T, F>

Sets retain flag for published messages.

Source

pub fn topic(&self) -> &ArcStr

Get the topic this publisher is configured for.

Source

pub fn qos(&self) -> QoS

Get qos level for this publisher.

Source

pub fn retain(&self) -> bool

Get retain flag for this publisher.

Source

pub async fn publish(&self, data: &T) -> Result<(), MqttClientError>

Publishes data to the configured topic.

Source

pub async fn publish_retain(&self, data: &T) -> Result<(), MqttClientError>

Publishes data with retain flag explicitly set to true.

Source

pub async fn publish_normal(&self, data: &T) -> Result<(), MqttClientError>

Publishes data with retain flag explicitly set to false.

Source

pub async fn clear_retained(&self) -> Result<(), MqttClientError>

Clear retained message for this topic

Sends an empty payload with retain=true to remove any retained message. Uses the same QoS level as configured for this publisher.

Auto Trait Implementations§

§

impl<T, F> Freeze for MqttPublisher<T, F>
where F: Freeze,

§

impl<T, F> RefUnwindSafe for MqttPublisher<T, F>

§

impl<T, F> Send for MqttPublisher<T, F>
where F: Send, T: Send,

§

impl<T, F> Sync for MqttPublisher<T, F>
where F: Sync, T: Sync,

§

impl<T, F> Unpin for MqttPublisher<T, F>
where F: Unpin, T: Unpin,

§

impl<T, F> UnwindSafe for MqttPublisher<T, F>
where F: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,