Struct rust_mqtt::packet::v5::auth_packet::AuthPacket
source · pub struct AuthPacket<'a, const MAX_PROPERTIES: usize> {
pub fixed_header: u8,
pub remain_len: u32,
pub auth_reason: u8,
pub property_len: u32,
pub properties: Vec<Property<'a>, MAX_PROPERTIES>,
}Expand description
Auth packets serves MQTTv5 extended authentication. This packet is not currently supported by rust-mqtt client but decoding and encoding of packet is prepared for future development.
Fields§
§fixed_header: u8§remain_len: u32§auth_reason: u8§property_len: u32§properties: Vec<Property<'a>, MAX_PROPERTIES>Implementations§
source§impl<'a, const MAX_PROPERTIES: usize> AuthPacket<'a, MAX_PROPERTIES>
impl<'a, const MAX_PROPERTIES: usize> AuthPacket<'a, MAX_PROPERTIES>
pub fn add_reason_code(&mut self, code: u8)
pub fn add_property(&mut self, p: Property<'a>)
Trait Implementations§
source§impl<'a, const MAX_PROPERTIES: usize> Packet<'a> for AuthPacket<'a, MAX_PROPERTIES>
impl<'a, const MAX_PROPERTIES: usize> Packet<'a> for AuthPacket<'a, MAX_PROPERTIES>
fn new() -> Self
source§fn encode(
&mut self,
buffer: &mut [u8],
buff_len: usize
) -> Result<usize, BufferError>
fn encode(
&mut self,
buffer: &mut [u8],
buff_len: usize
) -> Result<usize, BufferError>
Method encode provide way how to transfer Packet struct into Byte array (buffer)
source§fn decode(&mut self, buff_reader: &mut BuffReader<'a>) -> Result<(), BufferError>
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
source§fn set_property_len(&mut self, value: u32)
fn set_property_len(&mut self, value: u32)
Setter method for packet properties len - not all Packet types support this
source§fn get_property_len(&mut self) -> u32
fn get_property_len(&mut self) -> u32
Setter method for packet properties len - not all Packet types support this
source§fn push_to_properties(&mut self, property: Property<'a>)
fn push_to_properties(&mut self, property: Property<'a>)
Method enables pushing new property into packet properties
source§fn property_allowed(&mut self, property: &Property<'a>) -> bool
fn property_allowed(&mut self, property: &Property<'a>) -> bool
Returns if property is allowed for packet
source§fn set_fixed_header(&mut self, header: u8)
fn set_fixed_header(&mut self, header: u8)
Setter for packet fixed header
source§fn set_remaining_len(&mut self, remaining_len: u32)
fn set_remaining_len(&mut self, remaining_len: u32)
Setter for remaining len
source§fn add_properties<const MAX_PROPERTIES: usize>(
&mut self,
properties: &Vec<Property<'a>, MAX_PROPERTIES>
) -> u32
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
source§fn decode_properties(
&mut self,
buff_reader: &mut BuffReader<'a>
) -> Result<(), BufferError>
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
source§fn decode_fixed_header(
&mut self,
buff_reader: &mut BuffReader<'_>
) -> Result<PacketType, BufferError>
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