Enum Property

pub enum Property {
    PayloadFormatIndicator(PayloadFormatIndicator),
    MessageExpiryInterval(MessageExpiryInterval),
    ContentType(ContentType),
    ResponseTopic(ResponseTopic),
    CorrelationData(CorrelationData),
    SubscriptionIdentifier(SubscriptionIdentifier),
    SessionExpiryInterval(SessionExpiryInterval),
    AssignedClientIdentifier(AssignedClientIdentifier),
    ServerKeepAlive(ServerKeepAlive),
    AuthenticationMethod(AuthenticationMethod),
    AuthenticationData(AuthenticationData),
    RequestProblemInformation(RequestProblemInformation),
    WillDelayInterval(WillDelayInterval),
    RequestResponseInformation(RequestResponseInformation),
    ResponseInformation(ResponseInformation),
    ServerReference(ServerReference),
    ReasonString(ReasonString),
    ReceiveMaximum(ReceiveMaximum),
    TopicAliasMaximum(TopicAliasMaximum),
    TopicAlias(TopicAlias),
    MaximumQos(MaximumQos),
    RetainAvailable(RetainAvailable),
    UserProperty(UserProperty),
    MaximumPacketSize(MaximumPacketSize),
    WildcardSubscriptionAvailable(WildcardSubscriptionAvailable),
    SubscriptionIdentifierAvailable(SubscriptionIdentifierAvailable),
    SharedSubscriptionAvailable(SharedSubscriptionAvailable),
}

MQTT v5.0 Property enum

This enum represents all possible MQTT v5.0 properties that can be included in various packet types. Each variant wraps a specific property type with its associated data and validation rules.

Properties provide extensibility to MQTT packets, allowing clients and servers to communicate additional metadata, control flow information, and authentication data.

Usage

Properties are typically collected in a Vec<Property> and included in MQTT packets during construction or parsing.

Examples

use mqtt_protocol_core::mqtt;

// Create a message expiry property
let expiry = mqtt::packet::MessageExpiryInterval::new(3600).unwrap();
let property = mqtt::packet::Property::MessageExpiryInterval(expiry);

// Create user property
let user_prop = mqtt::packet::UserProperty::new("key", "value").unwrap();
let property = mqtt::packet::Property::UserProperty(user_prop);

Variants

PayloadFormatIndicator(PayloadFormatIndicator)

MessageExpiryInterval(MessageExpiryInterval)

ContentType(ContentType)

ResponseTopic(ResponseTopic)

CorrelationData(CorrelationData)

SubscriptionIdentifier(SubscriptionIdentifier)

SessionExpiryInterval(SessionExpiryInterval)

AssignedClientIdentifier(AssignedClientIdentifier)

ServerKeepAlive(ServerKeepAlive)

AuthenticationMethod(AuthenticationMethod)

AuthenticationData(AuthenticationData)

RequestProblemInformation(RequestProblemInformation)

WillDelayInterval(WillDelayInterval)

RequestResponseInformation(RequestResponseInformation)

ResponseInformation(ResponseInformation)

ServerReference(ServerReference)

ReasonString(ReasonString)

ReceiveMaximum(ReceiveMaximum)

TopicAliasMaximum(TopicAliasMaximum)

TopicAlias(TopicAlias)

MaximumQos(MaximumQos)

RetainAvailable(RetainAvailable)

UserProperty(UserProperty)

MaximumPacketSize(MaximumPacketSize)

WildcardSubscriptionAvailable(WildcardSubscriptionAvailable)

SubscriptionIdentifierAvailable(SubscriptionIdentifierAvailable)

SharedSubscriptionAvailable(SharedSubscriptionAvailable)

Implementations

impl Property

pub fn id(&self) -> PropertyId

Get the property identifier for this property

Returns the PropertyId that corresponds to this property type. This is useful for determining the property type without matching on the enum variant.

Examples

use mqtt_protocol_core::mqtt;

let prop = mqtt::packet::Property::MessageExpiryInterval(
    mqtt::packet::MessageExpiryInterval::new(3600).unwrap()
);
assert_eq!(prop.id(), mqtt::packet::PropertyId::MessageExpiryInterval);

pub fn size(&self) -> usize

Get the encoded size of this property in bytes

Returns the total number of bytes required to encode this property in the MQTT wire format, including the property identifier and any length prefixes.

Examples

use mqtt_protocol_core::mqtt;

let prop = mqtt::packet::Property::MessageExpiryInterval(
    mqtt::packet::MessageExpiryInterval::new(3600).unwrap()
);
let size = prop.size(); // 1 byte ID + 4 bytes value = 5 bytes

pub fn to_buffers(&self) -> Vec<IoSlice<'_>>

Create IoSlice buffers for efficient network I/O

Returns a vector of IoSlice objects that can be used for vectored I/O operations, allowing zero-copy writes to network sockets. The buffers include the property identifier and the encoded property value.

Examples

use mqtt_protocol_core::mqtt;

let prop = mqtt::packet::Property::ContentType(
    mqtt::packet::ContentType::new("application/json").unwrap()
);
let buffers = prop.to_buffers();
// Can be used with vectored write operations
// socket.write_vectored(&buffers)?;

pub fn parse(bytes: &[u8]) -> Result<(Self, usize), MqttError>

Parse a property from a byte sequence

Decodes a single MQTT property from a byte buffer according to the MQTT v5.0 specification. The buffer must start with a property identifier byte followed by the property value in the appropriate format.

Parameters

• bytes - Byte buffer containing the encoded property data

Returns

• Ok((Property, bytes_consumed)) - Successfully parsed property and number of bytes consumed
• Err(MqttError::MalformedPacket) - If the buffer is too short, contains an invalid property ID, or malformed property data

Examples

use mqtt_protocol_core::mqtt;

// Buffer: [property_id, property_data...]
let buffer = &[0x02, 0x00, 0x00, 0x0E, 0x10]; // MessageExpiryInterval = 3600
let (property, consumed) = mqtt::packet::Property::parse(buffer).unwrap();

match property {
    mqtt::packet::Property::MessageExpiryInterval(prop) => {
        assert_eq!(prop.val(), 3600);
    }
    _ => panic!("Wrong property type"),
}
assert_eq!(consumed, 5);

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl Display for Property

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

Formats the value using the given formatter.

impl From<AssignedClientIdentifier> for Property

fn from(v: AssignedClientIdentifier) -> Self

Converts to this type from the input type.

impl From<AuthenticationData> for Property

fn from(v: AuthenticationData) -> Self

Converts to this type from the input type.

impl From<AuthenticationMethod> for Property

fn from(v: AuthenticationMethod) -> Self

Converts to this type from the input type.

impl From<ContentType> for Property

fn from(v: ContentType) -> Self

Converts to this type from the input type.

impl From<CorrelationData> for Property

fn from(v: CorrelationData) -> Self

Converts to this type from the input type.

impl From<MaximumPacketSize> for Property

fn from(v: MaximumPacketSize) -> Self

Converts to this type from the input type.

impl From<MaximumQos> for Property

fn from(v: MaximumQos) -> Self

Converts to this type from the input type.

impl From<MessageExpiryInterval> for Property

fn from(v: MessageExpiryInterval) -> Self

Converts to this type from the input type.

impl From<PayloadFormatIndicator> for Property

fn from(v: PayloadFormatIndicator) -> Self

Converts to this type from the input type.

impl From<ReasonString> for Property

fn from(v: ReasonString) -> Self

Converts to this type from the input type.

impl From<ReceiveMaximum> for Property

fn from(v: ReceiveMaximum) -> Self

Converts to this type from the input type.

impl From<RequestProblemInformation> for Property

fn from(v: RequestProblemInformation) -> Self

Converts to this type from the input type.

impl From<RequestResponseInformation> for Property

fn from(v: RequestResponseInformation) -> Self

Converts to this type from the input type.

impl From<ResponseInformation> for Property

fn from(v: ResponseInformation) -> Self

Converts to this type from the input type.

impl From<ResponseTopic> for Property

fn from(v: ResponseTopic) -> Self

Converts to this type from the input type.

impl From<RetainAvailable> for Property

fn from(v: RetainAvailable) -> Self

Converts to this type from the input type.

impl From<ServerKeepAlive> for Property

fn from(v: ServerKeepAlive) -> Self

Converts to this type from the input type.

impl From<ServerReference> for Property

fn from(v: ServerReference) -> Self

Converts to this type from the input type.

impl From<SessionExpiryInterval> for Property

fn from(v: SessionExpiryInterval) -> Self

Converts to this type from the input type.

impl From<SharedSubscriptionAvailable> for Property

fn from(v: SharedSubscriptionAvailable) -> Self

Converts to this type from the input type.

impl From<SubscriptionIdentifier> for Property

fn from(v: SubscriptionIdentifier) -> Self

Converts to this type from the input type.

impl From<SubscriptionIdentifierAvailable> for Property

fn from(v: SubscriptionIdentifierAvailable) -> Self

Converts to this type from the input type.

impl From<TopicAlias> for Property

fn from(v: TopicAlias) -> Self

Converts to this type from the input type.

impl From<TopicAliasMaximum> for Property

fn from(v: TopicAliasMaximum) -> Self

Converts to this type from the input type.

impl From<UserProperty> for Property

fn from(v: UserProperty) -> Self

Converts to this type from the input type.

impl From<WildcardSubscriptionAvailable> for Property

fn from(v: WildcardSubscriptionAvailable) -> Self

Converts to this type from the input type.

impl From<WillDelayInterval> for Property

fn from(v: WillDelayInterval) -> Self

Converts to this type from the input type.

impl PartialEq for Property

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

fn as_u8(&self) -> Option<u8>

Extract u8 value from byte-based properties

fn as_u16(&self) -> Option<u16>

Extract u16 value from two-byte properties

fn as_u32(&self) -> Option<u32>

Extract u32 value from four-byte properties

fn as_str(&self) -> Option<&str>

Extract string value from string-based properties

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

Extract binary data from binary-based properties

fn as_key_value(&self) -> Option<(&str, &str)>

Extract key-value pair from UserProperty

impl Serialize for Property

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Property

impl StructuralPartialEq for Property