Enum PropertyId

#[repr(u8)]
pub enum PropertyId {
    PayloadFormatIndicator = 1,
    MessageExpiryInterval = 2,
    ContentType = 3,
    ResponseTopic = 8,
    CorrelationData = 9,
    SubscriptionIdentifier = 11,
    SessionExpiryInterval = 17,
    AssignedClientIdentifier = 18,
    ServerKeepAlive = 19,
    AuthenticationMethod = 21,
    AuthenticationData = 22,
    RequestProblemInformation = 23,
    WillDelayInterval = 24,
    RequestResponseInformation = 25,
    ResponseInformation = 26,
    ServerReference = 28,
    ReasonString = 31,
    ReceiveMaximum = 33,
    TopicAliasMaximum = 34,
    TopicAlias = 35,
    MaximumQos = 36,
    RetainAvailable = 37,
    UserProperty = 38,
    MaximumPacketSize = 39,
    WildcardSubscriptionAvailable = 40,
    SubscriptionIdentifierAvailable = 41,
    SharedSubscriptionAvailable = 42,
}

MQTT v5.0 Property Identifiers

This enum represents all property identifiers defined in the MQTT v5.0 specification. Properties are used to extend MQTT packets with additional metadata and control information.

Each property has a unique identifier (1-42) and is associated with specific packet types. Properties provide enhanced functionality such as message expiry, user properties, authentication data, and various server capabilities.

Specification Reference

See MQTT v5.0 Properties for detailed information about each property.

Examples

use mqtt_protocol_core::mqtt;

let property_id = mqtt::packet::PropertyId::MessageExpiryInterval;
assert_eq!(property_id.as_u8(), 2);
assert_eq!(property_id.as_str(), "message_expiry_interval");

Variants

PayloadFormatIndicator = 1

Indicates the format of the payload in PUBLISH packets (0=binary, 1=UTF-8)

MessageExpiryInterval = 2

Message expiry interval in seconds

ContentType = 3

Content type of the application message

ResponseTopic = 8

Topic name for response messages

CorrelationData = 9

Correlation data for request/response messaging

SubscriptionIdentifier = 11

Subscription identifier for matching subscriptions

SessionExpiryInterval = 17

Session expiry interval in seconds

AssignedClientIdentifier = 18

Client identifier assigned by the server

ServerKeepAlive = 19

Keep alive time assigned by the server

AuthenticationMethod = 21

Authentication method name

AuthenticationData = 22

Authentication data

RequestProblemInformation = 23

Request problem information flag

WillDelayInterval = 24

Will delay interval in seconds

RequestResponseInformation = 25

Request response information flag

ResponseInformation = 26

Response information string

ServerReference = 28

Server reference for redirection

ReasonString = 31

Human readable reason string

ReceiveMaximum = 33

Maximum number of concurrent PUBLISH packets

TopicAliasMaximum = 34

Maximum topic alias value

TopicAlias = 35

Topic alias value

MaximumQos = 36

Maximum QoS level supported

RetainAvailable = 37

Retain availability flag

UserProperty = 38

User-defined property key-value pair

MaximumPacketSize = 39

Maximum packet size

WildcardSubscriptionAvailable = 40

Wildcard subscription availability flag

SubscriptionIdentifierAvailable = 41

Subscription identifier availability flag

SharedSubscriptionAvailable = 42

Shared subscription availability flag

Implementations

impl PropertyId

pub fn as_u8(self) -> u8

Get the numeric identifier of the property

Returns the property identifier as defined in the MQTT v5.0 specification.

Examples

use mqtt_protocol_core::mqtt;

let prop = mqtt::packet::PropertyId::MessageExpiryInterval;
assert_eq!(prop.as_u8(), 2);

pub fn as_str(&self) -> &'static str

Get the string representation of the property identifier

Returns a human-readable string name for the property, suitable for serialization and debugging purposes.

Examples

use mqtt_protocol_core::mqtt;

let prop = mqtt::packet::PropertyId::ContentType;
assert_eq!(prop.as_str(), "content_type");

Trait Implementations

impl Clone for PropertyId

fn clone(&self) -> PropertyId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PropertyId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PropertyId

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

Formats the value using the given formatter.

impl PartialEq for PropertyId

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u8> for PropertyId

type Error = TryFromPrimitiveError<PropertyId>

The type returned in the event of a conversion error.

fn try_from(number: u8) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for PropertyId

const NAME: &'static str = "PropertyId"

type Primitive = u8

type Error = TryFromPrimitiveError<PropertyId>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for PropertyId

impl Eq for PropertyId

impl StructuralPartialEq for PropertyId