Enum PayloadFormat

#[repr(u8)]
pub enum PayloadFormat {
    Binary = 0,
    String = 1,
}

Payload Format Indicator values

Specifies the format of the payload in PUBLISH packets. This helps receivers interpret the payload data correctly.

Specification Reference

See Payload Format Indicator in the MQTT v5.0 specification.

Examples

use mqtt_protocol_core::mqtt;

let format = mqtt::packet::PayloadFormat::String;
assert_eq!(format as u8, 1);

Variants

Binary = 0

Payload is unspecified bytes (binary data)

String = 1

Payload is UTF-8 encoded character data

Trait Implementations

impl Debug for PayloadFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PayloadFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PayloadFormat

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

Formats the value using the given formatter.

impl PartialEq for PayloadFormat

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

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 PayloadFormat

type Error = TryFromPrimitiveError<PayloadFormat>

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 PayloadFormat

const NAME: &'static str = "PayloadFormat"

type Primitive = u8

type Error = TryFromPrimitiveError<PayloadFormat>

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

impl Eq for PayloadFormat

impl StructuralPartialEq for PayloadFormat