Struct UserProperty

pub struct UserProperty { /* private fields */ }

Implementations

impl UserProperty

pub fn id(&self) -> PropertyId

Returns the PropertyId of this property.

Returns

The PropertyId enum value.

Examples

let prop = Property::new(...);
let id = prop.id();

impl UserProperty

pub fn new<K, V>(key: K, val: V) -> Result<Self, MqttError>

where K: AsRef<str>, V: AsRef<str>,

Creates a new string pair property with the given key and value.

Parameters

• key - The key string
• val - The value string

Returns

• Ok(Self) - Successfully created property
• Err(MqttError) - If either string is invalid or too long

Examples

let prop = UserProperty::new("name", "value").unwrap();

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

Parses a string pair property from the given byte slice.

Parameters

• bytes - The byte slice to parse from

Returns

• Ok((Self, usize)) - The parsed property and number of bytes consumed
• Err(MqttError) - If parsing fails

Examples

let data = &[0x00, 0x03, b'k', b'e', b'y', 0x00, 0x05, b'v', b'a', b'l', b'u', b'e'];
let (prop, consumed) = UserProperty::parse(data).unwrap();
assert_eq!(consumed, 12);

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

Converts the property to I/O slices for efficient transmission.

Returns

A vector of I/O slices containing the property data.

Examples

let prop = UserProperty::new("name", "value").unwrap();
let buffers = prop.to_buffers();

pub fn to_continuous_buffer(&self) -> Vec<u8>

Converts the property to a continuous buffer.

Returns

A byte vector containing the complete property data.

Examples

let prop = UserProperty::new("key", "value").unwrap();
let buffer = prop.to_continuous_buffer();

pub fn key(&self) -> &str

Returns the key string of this property.

Returns

A reference to the key string.

Examples

let prop = UserProperty::new("name", "value").unwrap();
assert_eq!(prop.key(), "name");

pub fn val(&self) -> &str

Returns the value string of this property.

Returns

A reference to the value string.

Examples

let prop = UserProperty::new("name", "value").unwrap();
assert_eq!(prop.val(), "value");

pub fn size(&self) -> usize

Returns the total size of this property in bytes.

This includes the property ID (1 byte) plus both key and value string sizes.

Returns

The total size in bytes.

Examples

let prop = UserProperty::new("key", "value").unwrap();
assert_eq!(prop.size(), 13); // 1 (ID) + 2 (key len) + 3 (key) + 2 (val len) + 5 (val)

Trait Implementations

impl Clone for UserProperty

fn clone(&self) -> UserProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserProperty

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

Formats the value using the given formatter.

impl Display for UserProperty

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

Formats the value using the given formatter.

impl From<UserProperty> for Property

fn from(v: UserProperty) -> Self

Converts to this type from the input type.

impl PartialEq for UserProperty

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

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 UserProperty

impl StructuralPartialEq for UserProperty