Struct bevy_mqtt::MqttClient
source · pub struct MqttClient { /* private fields */ }Expand description
A component that represents an MQTT client
Methods from Deref<Target = AsyncClient>§
sourcepub async fn publish<S, V>(
&self,
topic: S,
qos: QoS,
retain: bool,
payload: V,
) -> Result<(), ClientError>
pub async fn publish<S, V>( &self, topic: S, qos: QoS, retain: bool, payload: V, ) -> Result<(), ClientError>
Sends a MQTT Publish to the EventLoop.
sourcepub fn try_publish<S, V>(
&self,
topic: S,
qos: QoS,
retain: bool,
payload: V,
) -> Result<(), ClientError>
pub fn try_publish<S, V>( &self, topic: S, qos: QoS, retain: bool, payload: V, ) -> Result<(), ClientError>
Attempts to send a MQTT Publish to the EventLoop.
sourcepub async fn ack(&self, publish: &Publish) -> Result<(), ClientError>
pub async fn ack(&self, publish: &Publish) -> Result<(), ClientError>
Sends a MQTT PubAck to the EventLoop. Only needed in if manual_acks flag is set.
sourcepub fn try_ack(&self, publish: &Publish) -> Result<(), ClientError>
pub fn try_ack(&self, publish: &Publish) -> Result<(), ClientError>
Attempts to send a MQTT PubAck to the EventLoop. Only needed in if manual_acks flag is set.
sourcepub async fn publish_bytes<S>(
&self,
topic: S,
qos: QoS,
retain: bool,
payload: Bytes,
) -> Result<(), ClientError>
pub async fn publish_bytes<S>( &self, topic: S, qos: QoS, retain: bool, payload: Bytes, ) -> Result<(), ClientError>
Sends a MQTT Publish to the EventLoop
sourcepub async fn subscribe<S>(&self, topic: S, qos: QoS) -> Result<(), ClientError>
pub async fn subscribe<S>(&self, topic: S, qos: QoS) -> Result<(), ClientError>
Sends a MQTT Subscribe to the EventLoop
sourcepub fn try_subscribe<S>(&self, topic: S, qos: QoS) -> Result<(), ClientError>
pub fn try_subscribe<S>(&self, topic: S, qos: QoS) -> Result<(), ClientError>
Attempts to send a MQTT Subscribe to the EventLoop
sourcepub async fn subscribe_many<T>(&self, topics: T) -> Result<(), ClientError>where
T: IntoIterator<Item = SubscribeFilter>,
pub async fn subscribe_many<T>(&self, topics: T) -> Result<(), ClientError>where
T: IntoIterator<Item = SubscribeFilter>,
Sends a MQTT Subscribe for multiple topics to the EventLoop
sourcepub fn try_subscribe_many<T>(&self, topics: T) -> Result<(), ClientError>where
T: IntoIterator<Item = SubscribeFilter>,
pub fn try_subscribe_many<T>(&self, topics: T) -> Result<(), ClientError>where
T: IntoIterator<Item = SubscribeFilter>,
Attempts to send a MQTT Subscribe for multiple topics to the EventLoop
sourcepub async fn unsubscribe<S>(&self, topic: S) -> Result<(), ClientError>
pub async fn unsubscribe<S>(&self, topic: S) -> Result<(), ClientError>
Sends a MQTT Unsubscribe to the EventLoop
sourcepub fn try_unsubscribe<S>(&self, topic: S) -> Result<(), ClientError>
pub fn try_unsubscribe<S>(&self, topic: S) -> Result<(), ClientError>
Attempts to send a MQTT Unsubscribe to the EventLoop
sourcepub async fn disconnect(&self) -> Result<(), ClientError>
pub async fn disconnect(&self) -> Result<(), ClientError>
Sends a MQTT disconnect to the EventLoop
sourcepub fn try_disconnect(&self) -> Result<(), ClientError>
pub fn try_disconnect(&self) -> Result<(), ClientError>
Attempts to send a MQTT disconnect to the EventLoop
Trait Implementations§
source§impl Deref for MqttClient
impl Deref for MqttClient
source§impl DerefMut for MqttClient
impl DerefMut for MqttClient
impl Resource for MqttClient
Auto Trait Implementations§
impl Freeze for MqttClient
impl !RefUnwindSafe for MqttClient
impl Send for MqttClient
impl Sync for MqttClient
impl Unpin for MqttClient
impl !UnwindSafe for MqttClient
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.