Struct rust_mqtt::packet::v5::pingreq_packet::PingreqPacket

pub struct PingreqPacket {
    pub fixed_header: u8,
    pub remain_len: u32,
}

Fields

fixed_header: u8

remain_len: u32

Trait Implementations

impl<'a> Packet<'a> for PingreqPacket

fn new() -> Self

fn encode(
    &mut self,
    buffer: &mut [u8],
    buffer_len: usize
) -> Result<usize, BufferError>

Method encode provide way how to transfer Packet struct into Byte array (buffer)

fn decode(
    &mut self,
    _buff_reader: &mut BuffReader<'a>
) -> Result<(), BufferError>

Decode method is opposite of encode - decoding Byte array and mapping it into corresponding Packet struct

fn set_property_len(&mut self, _value: u32)

Setter method for packet properties len - not all Packet types support this

fn get_property_len(&mut self) -> u32

Setter method for packet properties len - not all Packet types support this

fn push_to_properties(&mut self, _property: Property<'a>)

Method enables pushing new property into packet properties

fn property_allowed(&mut self, property: &Property<'a>) -> bool

Returns if property is allowed for packet

fn set_fixed_header(&mut self, header: u8)

Setter for packet fixed header

fn set_remaining_len(&mut self, remaining_len: u32)

Setter for remaining len

fn add_properties<const MAX_PROPERTIES: usize>(
    &mut self,
    properties: &Vec<Property<'a>, MAX_PROPERTIES>
) -> u32

Method enables adding properties from client config - each packet decides if property can be used with that or not

fn decode_properties(
    &mut self,
    buff_reader: &mut BuffReader<'a>
) -> Result<(), BufferError>

Method is decoding Byte array pointing to properties into heapless Vec in packet. If decoding goes wrong method is returning Error

fn decode_fixed_header(
    &mut self,
    buff_reader: &mut BuffReader<'_>
) -> Result<PacketType, BufferError>

Method is decoding packet header into fixed header part and remaining length