Struct FixedHeader

pub struct FixedHeader {
    pub packet_type: PacketType,
    pub flags: u8,
    pub remaining_length: u32,
}

MQTT packet fixed header

Fields

packet_type: PacketType

flags: u8

remaining_length: u32

Implementations

impl FixedHeader

pub fn new(packet_type: PacketType, flags: u8, remaining_length: u32) -> Self

Creates a new fixed header

pub fn encode<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes the fixed header

Errors

Returns an error if the remaining length is too large

Errors

Returns an error if the operation fails

pub fn decode<B: Buf>(buf: &mut B) -> Result<Self>

Decodes a fixed header from the buffer

Errors

Returns an error if:

• Insufficient bytes in buffer
• Invalid packet type
• Invalid remaining length

Errors

Returns an error if the operation fails

pub fn validate_flags(&self) -> bool

Validates the flags for the packet type

pub fn encoded_len(&self) -> usize

Returns the encoded length of the fixed header

Trait Implementations

impl Clone for FixedHeader

fn clone(&self) -> FixedHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FixedHeader

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

Formats the value using the given formatter.

impl PartialEq for FixedHeader

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

impl Eq for FixedHeader

impl StructuralPartialEq for FixedHeader