MqttOptions

Struct MqttOptions 

Source
pub struct MqttOptions<'a> { /* private fields */ }
Expand description

Options to configure the behaviour of mqtt connection

Lifetimes:

  • ’a: The lifetime of option fields, not referenced in any MQTT packets at any point
  • ’b: The lifetime of the packet fields, backed by a slice buffer

Implementations§

Source§

impl<'a> MqttOptions<'a>

Source

pub fn new(id: &'a str, broker: Broker<'a>, port: u16) -> MqttOptions<'a>

New mqtt options

Source

pub fn broker(&self) -> (Broker<'_>, u16)

Broker address

Source

pub fn set_broker(self, broker: Broker<'a>) -> Self

Broker address

Source

pub fn set_port(self, port: u16) -> Self

Source

pub fn set_last_will(self, will: LastWill<'a>) -> Self

Source

pub fn last_will(&self) -> Option<LastWill<'a>>

Source

pub fn set_keep_alive(self, secs: u16) -> Self

Set number of seconds after which client should ping the broker if there is no other data exchange

Source

pub fn keep_alive_ms(&self) -> u32

Keep alive time

Source

pub fn client_id(&self) -> &'a str

Client identifier

Source

pub fn set_clean_session(self, clean_session: bool) -> Self

clean_session = true removes all the state from queues & instructs the broker to clean all the client state when client disconnects.

When set false, broker will hold the client state and performs pending operations on the client when reconnection with same client_id happens. Local queue state is also held to retransmit packets after reconnection.

Source

pub fn clean_session(&self) -> bool

Clean session

Source

pub fn set_credentials(self, username: &'a str, password: &'a [u8]) -> Self

Username and password

Source

pub fn credentials(&self) -> (Option<&'a str>, Option<&'a [u8]>)

Security options

Trait Implementations§

Source§

impl<'a> Clone for MqttOptions<'a>

Source§

fn clone(&self) -> MqttOptions<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for MqttOptions<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for MqttOptions<'a>

§

impl<'a> RefUnwindSafe for MqttOptions<'a>

§

impl<'a> Send for MqttOptions<'a>

§

impl<'a> Sync for MqttOptions<'a>

§

impl<'a> Unpin for MqttOptions<'a>

§

impl<'a> UnwindSafe for MqttOptions<'a>

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, 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.