Struct FixedHeader 

pub struct FixedHeader { /* private fields */ }

Fixed header part of a mqtt control packet. It consists of as least two bytes.

 7 6 5 4 3 2 1 0
+-------+-------+
| Type  | Flags |
+-------+-------+
| Remaining Len |
+-------+-------+

Implementations

impl FixedHeader

pub fn new( packet_type: PacketType, remaining_length: usize, ) -> Result<Self, VarIntError>

Create a new fixed header with packet_type and remaining_length.

Errors

Returns error if remaining_length is invalid.

pub const fn packet_type(&self) -> PacketType

pub const fn remaining_length(&self) -> usize

pub const fn bytes(&self) -> usize

Get byte length in packet.

pub fn is_valid_header(&self, protocol_level: ProtocolLevel) -> bool

Check whether this fixed header is valid within specific protocol_level.

Note that Auth packet is only available in MQTT 5.0.

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 DecodePacket for FixedHeader

fn decode(ba: &mut ByteArray<'_>) -> Result<Self, DecodeError>

Decode byte array into a mqtt packet.

impl Default for FixedHeader

fn default() -> FixedHeader

Returns the “default value” for a type.

impl EncodePacket for FixedHeader

fn encode(&self, v: &mut Vec<u8>) -> Result<usize, EncodeError>

Encode packets into byte array.

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