Struct PayloadFormatIndicator 

pub struct PayloadFormatIndicator { /* private fields */ }

Implementations

impl PayloadFormatIndicator

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 PayloadFormatIndicator

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

Parses a u8 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 or validation fails

Examples

let data = &[42];
let (prop, consumed) = PayloadFormatIndicator::parse(data).unwrap();
assert_eq!(consumed, 1);

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 = PayloadFormatIndicator::new(1).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 = Property::new(...).unwrap();
let buffer = prop.to_continuous_buffer();

pub fn val(&self) -> u8

Returns the u8 value of this property.

Returns

The u8 value.

Examples

let prop = PayloadFormatIndicator::new(1).unwrap();
assert_eq!(prop.val(), 1);

pub fn size(&self) -> usize

Returns the total size of this property in bytes.

This includes the property ID (1 byte) plus the u8 value (1 byte).

Returns

The total size in bytes (always 2 for u8 properties).

Examples

let prop = PayloadFormatIndicator::new(1).unwrap();
assert_eq!(prop.size(), 2);

impl PayloadFormatIndicator

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

Creates a new PayloadFormatIndicator property.

Parameters

• v - The PayloadFormat enum value

Returns

• Ok(Self) - Successfully created property
• Err(MqttError) - If creation fails

Examples

let prop = PayloadFormatIndicator::new(PayloadFormat::Utf8String).unwrap();

Trait Implementations

impl Clone for PayloadFormatIndicator

fn clone(&self) -> PayloadFormatIndicator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadFormatIndicator

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

Formats the value using the given formatter.

impl Display for PayloadFormatIndicator

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

Formats the value using the given formatter.

impl From<PayloadFormatIndicator> for Property

fn from(v: PayloadFormatIndicator) -> Self

Converts to this type from the input type.

impl PartialEq for PayloadFormatIndicator

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

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 PayloadFormatIndicator

impl StructuralPartialEq for PayloadFormatIndicator