Struct MqttConnectionSettingsBuilder

pub struct MqttConnectionSettingsBuilder { /* private fields */ }

Builder for MqttConnectionSettings.

Implementations

impl MqttConnectionSettingsBuilder

pub fn client_id<VALUE: Into<String>>(self, value: VALUE) -> Self

Client identifier

pub fn hostname<VALUE: Into<String>>(self, value: VALUE) -> Self

FQDN of the host to connect to

pub fn tcp_port<VALUE: Into<u16>>(self, value: VALUE) -> Self

TCP port to connect to the host on

pub fn keep_alive<VALUE: Into<Duration>>(self, value: VALUE) -> Self

Max time between communications

pub fn receive_max<VALUE: Into<u16>>(self, value: VALUE) -> Self

Max number of in-flight Quality of Service 1 and 2 messages

pub fn receive_packet_size_max<VALUE: Into<Option<u32>>>( self, value: VALUE, ) -> Self

Max size of a received packet

pub fn session_expiry<VALUE: Into<Duration>>(self, value: VALUE) -> Self

Session Expiry Interval

pub fn connection_timeout<VALUE: Into<Duration>>(self, value: VALUE) -> Self

Connection timeout

pub fn clean_start<VALUE: Into<bool>>(self, value: VALUE) -> Self

Clean start

pub fn username<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Username for MQTT

pub fn password<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Password for MQTT

pub fn password_file<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Path to a file containing the MQTT password

pub fn use_tls<VALUE: Into<bool>>(self, value: VALUE) -> Self

TLS negotiation enabled

pub fn ca_file<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Path to a PEM file used to validate server identity

pub fn cert_file<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Path to PEM file used to establish X509 client authentication

pub fn key_file<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Path to a file containing a key used to establish X509 client authentication

pub fn key_password_file<VALUE: Into<Option<String>>>( self, value: VALUE, ) -> Self

Path to a file containing the password used to decrypt the Key

pub fn sat_file<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

Path to a SAT file to be used for SAT auth

pub fn build( self, ) -> Result<MqttConnectionSettings, MqttConnectionSettingsBuilderError>

Builds a new MqttConnectionSettings.

Errors

If a required field has not been initialized.

impl MqttConnectionSettingsBuilder

pub fn from_environment() -> Result<Self, String>

Initialize the MqttConnectionSettingsBuilder from environment variables.

Values that are not present in the environment will be set to defaults (including those that are not possible to be provided by the AIO environment variables).

Example

let connection_settings = MqttConnectionSettingsBuilder::from_environment().unwrap().build()?;

Errors

Returns a String describing the error if any of the environment variables contain invalid data.

Trait Implementations

impl Default for MqttConnectionSettingsBuilder

fn default() -> Self

Returns the “default value” for a type.