Struct Properties 

pub struct Properties { /* private fields */ }

Container for MQTT v5.0 properties

Implementations

impl Properties

pub fn new() -> Self

Creates a new empty properties container

pub fn add(&mut self, id: PropertyId, value: PropertyValue) -> Result<()>

Adds a property value

Errors

Returns an error if:

• The value type doesn’t match the property’s expected type
• The property doesn’t allow multiple values and already exists

Errors

Returns an error if the operation fails

pub fn get(&self, id: PropertyId) -> Option<&PropertyValue>

Gets a single property value

pub fn get_all(&self, id: PropertyId) -> Option<&[PropertyValue]>

Gets all values for a property (for properties that allow multiple values)

pub fn contains(&self, id: PropertyId) -> bool

Checks if a property is present

pub fn len(&self) -> usize

Returns the number of properties (counting multi-value properties as one)

pub fn is_empty(&self) -> bool

Checks if there are no properties

pub fn iter(&self) -> impl Iterator<Item = (PropertyId, &PropertyValue)> + '_

Iterates over all properties and their values

pub fn encode<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes all properties to the buffer

Errors

Returns an error if encoding fails

Errors

Returns an error if the operation fails

pub fn decode<B: Buf>(buf: &mut B) -> Result<Self>

Decodes properties from the buffer

Errors

Returns an error if:

• Decoding fails
• Invalid property ID
• Type mismatch
• Duplicate property that doesn’t allow multiples

Errors

Returns an error if the operation fails

pub fn encoded_len(&self) -> usize

Calculates the encoded length of all properties (including length prefix)

pub fn set_payload_format_indicator(&mut self, is_utf8: bool)

Sets the payload format indicator (0 = unspecified bytes, 1 = UTF-8)

pub fn set_message_expiry_interval(&mut self, seconds: u32)

Sets the message expiry interval in seconds

pub fn get_message_expiry_interval(&self) -> Option<u32>

Gets the message expiry interval in seconds

pub fn set_topic_alias(&mut self, alias: u16)

Sets the topic alias

pub fn get_topic_alias(&self) -> Option<u16>

Gets the topic alias

pub fn set_response_topic(&mut self, topic: String)

Sets the response topic

pub fn set_correlation_data(&mut self, data: Bytes)

Sets the correlation data

pub fn add_user_property(&mut self, key: String, value: String)

Adds a user property (can be called multiple times)

pub fn set_subscription_identifier(&mut self, id: u32)

Sets the subscription identifier

pub fn get_subscription_identifier(&self) -> Option<u32>

pub fn set_session_expiry_interval(&mut self, seconds: u32)

Sets the session expiry interval

pub fn get_session_expiry_interval(&self) -> Option<u32>

Gets the session expiry interval

pub fn set_assigned_client_identifier(&mut self, id: String)

Sets the assigned client identifier

pub fn set_server_keep_alive(&mut self, seconds: u16)

Sets the server keep alive

pub fn set_authentication_method(&mut self, method: String)

Sets the authentication method

pub fn set_authentication_data(&mut self, data: Bytes)

Sets the authentication data

pub fn get_authentication_method(&self) -> Option<&String>

pub fn get_authentication_data(&self) -> Option<&[u8]>

pub fn set_request_problem_information(&mut self, request: bool)

Sets request problem information

pub fn get_request_problem_information(&self) -> Option<bool>

Gets request problem information

pub fn set_will_delay_interval(&mut self, seconds: u32)

Sets the will delay interval

pub fn set_request_response_information(&mut self, request: bool)

Sets request response information

pub fn get_request_response_information(&self) -> Option<bool>

Gets request response information

pub fn set_response_information(&mut self, info: String)

Sets the response information

pub fn set_server_reference(&mut self, reference: String)

Sets the server reference

pub fn set_reason_string(&mut self, reason: String)

Sets the reason string

pub fn set_receive_maximum(&mut self, max: u16)

Sets the receive maximum

pub fn get_receive_maximum(&self) -> Option<u16>

Gets the receive maximum

pub fn set_topic_alias_maximum(&mut self, max: u16)

Sets the topic alias maximum

pub fn get_topic_alias_maximum(&self) -> Option<u16>

Gets the topic alias maximum

pub fn set_maximum_qos(&mut self, qos: u8)

Sets the maximum QoS

pub fn set_retain_available(&mut self, available: bool)

Sets retain available

pub fn set_maximum_packet_size(&mut self, size: u32)

Sets the maximum packet size

pub fn set_wildcard_subscription_available(&mut self, available: bool)

Sets wildcard subscription available

pub fn set_subscription_identifier_available(&mut self, available: bool)

Sets subscription identifier available

pub fn set_shared_subscription_available(&mut self, available: bool)

Sets shared subscription available

pub fn get_maximum_qos(&self) -> Option<u8>

Gets the maximum QoS

pub fn set_content_type(&mut self, content_type: String)

Sets the content type

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Properties

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

Formats the value using the given formatter.

impl Default for Properties

fn default() -> Properties

Returns the “default value” for a type.

impl From<Properties> for MessageProperties

fn from(props: Properties) -> Self

Converts to this type from the input type.

impl From<PublishProperties> for Properties

fn from(props: PublishProperties) -> Self

Converts to this type from the input type.

impl From<WillProperties> for Properties

fn from(will_props: WillProperties) -> Self

Converts to this type from the input type.

impl PartialEq for Properties

fn eq(&self, other: &Properties) -> 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 Properties

impl StructuralPartialEq for Properties