Struct lmc::PublishFlags

pub struct PublishFlags(_);

This struct allows the developer to create and parse valid publish flags. See MQTT v3 protocol for more information.

Implementations

impl PublishFlags

pub const DUP: u8 = 8u8

The bit used to indicate a duplicate message

pub const QOS_MASK: u8 = 6u8

Mask for the QoS bits

pub const RETAIN: u8 = 1u8

The bit used for the retain flag

pub const ALL_BITS: u8 = 15u8

Mask containing all bits that may consitute valid publish flags

pub const fn new(dup: bool, qos: QoS, retain: bool) -> Self

Instantiates a new set of publish flags with the specified values:

• dup indicates that the message was already sent by the client before, but is about to be re-transmitted due to a lack of acknowledgment from the broker
• qos indicates the quality of service that will be used to send the message
• retain indicates that the message should be stored by the broker and transmitted when clients subscribe to the corresponding topic

pub const fn was_retained(self) -> bool

Indicates that the message was a retained message that is being transmitted by the broker in response to a topic subscription.

pub const fn qos(self) -> QoS

Indicates the quality of service used to receive the message. The client that sent the message initially might have used a different quality of service to transmit it.

pub const fn is_dup(self) -> bool

Indicates that this publish packet was already sent by the broker before, but was re-transmitted due to a lack of acknowledgment from the client.

pub const fn into_inner(self) -> u8

Converts the flags into their raw byte form.

Trait Implementations

impl Clone for PublishFlags

fn clone(&self) -> PublishFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PublishFlags> for PublishFlags

fn eq(&self, other: &PublishFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u8> for PublishFlags

fn try_from(value: u8) -> Result<Self, PacketDecodeError>

Validates PublishFlags in their raw byte form. If invalid bits are detected, [PacketDecodeError::MalformedPacket] is returned.

type Error = PacketDecodeError

The type returned in the event of a conversion error.

impl Copy for PublishFlags

impl Eq for PublishFlags

impl StructuralEq for PublishFlags

impl StructuralPartialEq for PublishFlags