Struct ConnectProperties

pub struct ConnectProperties {
    pub session_expiry_interval: Option<u32>,
    pub receive_maximum: Option<u16>,
    pub maximum_packet_size: Option<u32>,
    pub topic_alias_maximum: Option<u16>,
    pub request_response_info: Option<bool>,
    pub request_problem_info: Option<bool>,
    pub user_properties: Vec<(String, String)>,
    pub auth_method: Option<String>,
    pub auth_data: Option<Bytes>,
}

Represents the properties of a Connect packet in MQTT v5.

These properties provide extended functionality beyond the basic connection parameters, including session management, flow control, and authentication.

Example

use mqute_codec::protocol::v5::ConnectProperties;

let connect_properties = ConnectProperties {
    session_expiry_interval: Some(3600u32),
    maximum_packet_size: Some(4096u32),
    ..Default::default()
};

Fields

session_expiry_interval: Option<u32>

Duration in seconds after which the session expires

receive_maximum: Option<u16>

Maximum number of QoS 1 and 2 publishes the client will process

maximum_packet_size: Option<u32>

Maximum packet size the client will accept

topic_alias_maximum: Option<u16>

Highest value the client will accept as a topic alias

request_response_info: Option<bool>

Whether the server should include response information

request_problem_info: Option<bool>

Whether the server should include reason strings

user_properties: Vec<(String, String)>

User-defined key-value properties

auth_method: Option<String>

Authentication method name

auth_data: Option<Bytes>

Authentication data

Trait Implementations

impl Clone for ConnectProperties

fn clone(&self) -> ConnectProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectProperties

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

Formats the value using the given formatter.

impl Default for ConnectProperties

fn default() -> ConnectProperties

Returns the “default value” for a type.

impl PartialEq for ConnectProperties

fn eq(&self, other: &ConnectProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConnectProperties

impl StructuralPartialEq for ConnectProperties