Struct poster::ConnectOpts

pub struct ConnectOpts<'a> { /* private fields */ }

Connection options, represented as a consuming builder. Used during connection request, translated to the CONNECT packet.

Implementations

impl<'a> ConnectOpts<'a>

pub fn new() -> Self

Creates a new ConnectOpts instance.

pub fn client_identifier(self, val: &'a str) -> Self

Sets the client identifier.

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

Sets the session keep alive.

Arguments

val - Duration value less than u16::MAX in seconds.

Panics

When the duration in seconds is greater than u16::MAX.

pub fn session_expiry_interval(self, val: Duration) -> Self

Sets the session expiry interval.

Arguments

val - Duration value less than u32::MAX in seconds.

Panics

When the duration in seconds is greater than u32::MAX.

pub fn receive_maximum(self, val: u16) -> Self

Sets the maximum incoming QoS>0 publish messages handled at once.

Arguments

val - value greater than 0

Panics

When val equals 0.

pub fn maximum_packet_size(self, val: u32) -> Self

Sets the maximum packet size (in bytes).

Arguments

val - value greater than 0

Panics

When val equals 0.

pub fn topic_alias_maximum(self, val: u16) -> Self

Sets the maximum accepted value of topic alias.

pub fn request_response_information(self, val: bool) -> Self

Requests the broker to return response information in ConnectRsp.

pub fn request_problem_information(self, val: bool) -> Self

Requests the broker to return additional diagnostic data (reason string, user properties) in ConnectRsp.

pub fn authentication_method(self, val: &'a str) -> Self

Sets the name of the authentication method used for extended authorization.

pub fn authentication_data(self, val: &'a [u8]) -> Self

Sets the binary authentication data. Note that setting authentication data without authentication_method set will result in an error.

pub fn user_property(self, (key, val): (&'a str, &'a str)) -> Self

Sets user properties as key-value pairs. Multiple user properties may be set.

pub fn will_qos(self, val: QoS) -> Self

QoS used for will messages.

pub fn will_retain(self, val: bool) -> Self

Retain for will messages.

pub fn clean_start(self, val: bool) -> Self

Clears the session upon connection.

pub fn will_delay_interval(self, val: Duration) -> Self

Sets delay before publishing will messages.

Arguments

val - Duration value less than u32::MAX in seconds.

Panics

When the duration in seconds is greater than u32::MAX.

pub fn will_payload_format_indicator(self, val: bool) -> Self

Sets payload format indicator for will messages. Value false indicates that the will payload is in unspecified format. Value true indicates that the payload is UTF8 encoded character data.

pub fn will_message_expiry_interval(self, val: Duration) -> Self

Sets the expiry interval of the will messages.

Arguments

val - Duration value less than u32::MAX in seconds.

Panics

When the duration in seconds is greater than u32::MAX.

pub fn will_content_type(self, val: &'a str) -> Self

Sets the content type of will messages.

pub fn will_response_topic(self, val: &'a str) -> Self

Sets the response topic for will messages.

pub fn will_correlation_data(self, val: &'a [u8]) -> Self

Sets the correlation data for will messages.

pub fn will_user_property(self, (key, val): (&'a str, &'a str)) -> Self

Sets user properties for will messages as key-value pairs. Multiple user properties may be set.

pub fn will_topic(self, val: &'a str) -> Self

Sets the topic for will messages.

pub fn will_payload(self, val: &'a [u8]) -> Self

Sets the binary payload for will messages.

pub fn username(self, val: &'a str) -> Self

Sets the username for normal authorization.

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

Sets the password for normal authorization.

Trait Implementations

impl<'a> Default for ConnectOpts<'a>

fn default() -> ConnectOpts<'a>

Returns the “default value” for a type.