Struct CorrelationData 

pub struct CorrelationData { /* private fields */ }

Implementations

impl CorrelationData

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 CorrelationData

pub fn new<T>(v: T) -> Result<Self, MqttError>

where T: AsRef<[u8]>,

Creates a new binary property with the given value.

Parameters

• v - The binary value to set (can be any type that converts to bytes)

Returns

• Ok(Self) - Successfully created property
• Err(MqttError) - If the binary data is invalid or too large

Examples

let prop = CorrelationData::new(b"correlation-123").unwrap();

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

Parses a binary 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, 0x05, b'h', b'e', b'l', b'l', b'o'];
let (prop, consumed) = CorrelationData::parse(data).unwrap();
assert_eq!(consumed, 7);

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 = CorrelationData::new(b"data").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 = CorrelationData::new(b"data").unwrap();
let buffer = prop.to_continuous_buffer();

Converts the property to a continuous buffer.

Returns

A byte vector containing the complete property data.

Examples

let prop = Property::new(...).unwrap();
let buffer = prop.to_continuous_buffer();

pub fn val(&self) -> &[u8]

Returns the binary value of this property.

Returns

A reference to the binary data as a byte slice.

Examples

let prop = CorrelationData::new(b"hello").unwrap();
assert_eq!(prop.val(), b"hello");

pub fn size(&self) -> usize

Returns the total size of this property in bytes.

This includes the property ID (1 byte) plus the binary data size.

Returns

The total size in bytes.

Examples

let prop = CorrelationData::new(b"hello").unwrap();
assert_eq!(prop.size(), 8); // 1 (ID) + 2 (length) + 5 (data)

Trait Implementations

impl Clone for CorrelationData

fn clone(&self) -> CorrelationData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CorrelationData

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

Formats the value using the given formatter.

impl Display for CorrelationData

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

Formats the value using the given formatter.

impl From<CorrelationData> for Property

fn from(v: CorrelationData) -> Self

Converts to this type from the input type.

impl PartialEq for CorrelationData

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

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 CorrelationData

impl StructuralPartialEq for CorrelationData