Skip to main content

MqttConfig

Struct MqttConfig 

Source
pub struct MqttConfig { /* private fields */ }
Expand description

Connection settings for an MqttTransport.

Construct with MqttConfig::new and refine with the chained setters; every field has a sensible default so only the broker address and client id are required.

Implementations§

Source§

impl MqttConfig

Source

pub fn new( client_id: impl Into<String>, host: impl Into<String>, port: u16, ) -> Self

Creates a configuration for the given client id and broker address.

§Arguments
  • client_id - the MQTT client identifier presented to the broker.
  • host - the broker hostname or IP address.
  • port - the broker TCP port, conventionally 1883 for plaintext MQTT.
§Returns

A configuration with a 30-second keep-alive, a request capacity of 64, and a default quality of service of QualityOfService::AtLeastOnce.

Source

pub fn keep_alive(self, interval: Duration) -> Self

Sets the keep-alive interval used to hold the connection open.

§Arguments
  • interval - how often the client pings the broker when otherwise idle.
§Returns

The updated configuration, for chaining.

Source

pub fn capacity(self, capacity: usize) -> Self

Sets the bound on outstanding client requests buffered toward the broker.

§Arguments
  • capacity - the request channel capacity; values below one are clamped to one.
§Returns

The updated configuration, for chaining.

Source

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

Sets the default quality of service for publishes and subscriptions.

§Arguments
§Returns

The updated configuration, for chaining.

Trait Implementations§

Source§

impl Clone for MqttConfig

Source§

fn clone(&self) -> MqttConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MqttConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.