Struct Packet

pub struct Packet<'a> { /* private fields */ }

Implementations

impl<'a> Packet<'a>

A full MQTT packet with fixed header, variable header and payload.

Variable header and payload are optional for some packet types.

pub fn connect( variable_header: Connect<'a>, payload: Connect<'a>, ) -> Result<Self, EncodeError>

Create a CONNECT packet.

pub fn subscribe( variable_header: PacketIdentifier, payload: Subscribe<'a>, ) -> Result<Self, EncodeError>

Create a SUBSCRIBE packet.

pub fn publish( flags: PublishFlags, variable_header: Publish<'a>, payload: &'a [u8], ) -> Result<Self, EncodeError>

Create a PUBLISH packet.

pub fn puback(variable_header: PacketIdentifier) -> Result<Self, EncodeError>

pub fn pingreq() -> Self

Create a PINGREQ packet.

pub fn pingresp() -> Self

Create a PINGRESP packet.

pub fn fixed_header(&self) -> &FixedHeader

Return a reference to the fixed header of the packet.

The len field of the returned header will be valid.

pub fn variable_header(&self) -> &Option<VariableHeader<'_>>

Return a reference to the variable header of the packet.

pub fn payload(&self) -> &Payload<'_>

Return a reference to the payload of the packet.

Trait Implementations

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl<'a> Decodable<'a> for Packet<'a>

fn decode(bytes: &'a [u8]) -> Result<Status<(usize, Self)>, DecodeError>

Decode any MQTT packet from a pre-allocated buffer.

If an unrecoverable error occurs an Err(x) is returned, the caller should disconnect and network connection and discard the contents of the connection receive buffer.

Decoding may return an Ok(Status::Partial(x)) in which case the caller should buffer at most x more bytes and then attempt decoding again.

If decoding succeeds an Ok(Status::Complete(x)) will be returned containing the number of bytes read from the buffer and the decoded packet. The lifetime of the decoded packet is tied to the input buffer.

impl<'a> Encodable for Packet<'a>

fn encoded_len(&self) -> usize

Calculate the exact length of the fully encoded packet.

The encode buffer will need to hold at least this number of bytes.

fn encode(&self, bytes: &mut [u8]) -> Result<usize, EncodeError>

Encode a packet for sending over a network connection.

If encoding fails an Err(x) is returned.

If encoding succeeds an Ok(written) is returned with the number of bytes written to the buffer.