Struct paho_mqtt::disconnect_options::DisconnectOptionsBuilder

pub struct DisconnectOptionsBuilder { /* private fields */ }

Builder to create the options for disconnecting from an MQTT server.

Implementations

impl DisconnectOptionsBuilder

pub fn new() -> Self

Create a new DisconnectOptionsBuilder

pub fn timeout(&mut self, timeout: Duration) -> &mut Self

Sets the time interval to allow the disconnect to complete. This specifies the time to allow in-flight messages to complete.

Arguments

timeout The time interval to allow the disconnect to complete. This has a resolution of seconds.

pub fn reason_code(&mut self, reason_code: ReasonCode) -> &mut Self

Set the reason for the disconnect.

The valid disconnect reasons are listed here in the spec: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901208

pub fn publish_will_message(&mut self) -> &mut Self

Tell the server to publish the will message on this disconnect.

This sets the reason code in the options to 0x04: “Disconnect with Will Message”

pub fn properties(&mut self, props: Properties) -> &mut Self

Sets the collection of properties for the disconnect.

Arguments

props The collection of properties to include with the disconnect message.

pub fn finalize(&self) -> DisconnectOptions

Finalize the builder to create the disconnect options.

Trait Implementations

impl Debug for DisconnectOptionsBuilder

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

Formats the value using the given formatter.

impl Default for DisconnectOptionsBuilder

fn default() -> DisconnectOptionsBuilder

Returns the “default value” for a type.