Struct Flags

pub struct Flags {
    pub dup: bool,
    pub qos: QoS,
    pub retain: bool,
}

Represents the control flags in an MQTT packet.

Examples

use mqute_codec::protocol::QoS;
use mqute_codec::protocol::Flags;

// Create default flags
let default_flags = Flags::default();
assert_eq!(default_flags.dup, false);
assert_eq!(default_flags.qos, QoS::AtMostOnce);
assert_eq!(default_flags.retain, false);

// Create custom flags
let custom_flags = Flags::new(QoS::AtLeastOnce);
assert_eq!(custom_flags.qos, QoS::AtLeastOnce);

Fields

dup: bool

Indicates if the packet is a duplicate.

qos: QoS

The Quality of Service level (0, 1, or 2).

retain: bool

Indicates if the message should be retained by the broker.

Implementations

impl Flags

pub fn new(qos: QoS) -> Self

Creates new Flags with the specified QoS level.

Examples

use mqute_codec::protocol::QoS;
use mqute_codec::protocol::Flags;

let flags = Flags::new(QoS::ExactlyOnce);
assert_eq!(flags.qos, QoS::ExactlyOnce);

pub fn is_default(&self) -> bool

Checks if the flags are set to their default values.

Examples

use mqute_codec::protocol::Flags;

let flags = Flags::default();
assert!(flags.is_default());

Trait Implementations

impl Clone for Flags

fn clone(&self) -> Flags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Default for Flags

fn default() -> Self

Creates default Flags with:

• dup: false
• qos: QoS::AtMostOnce
• retain: false

impl PartialEq for Flags

fn eq(&self, other: &Flags) -> 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 Flags

impl Eq for Flags

impl StructuralPartialEq for Flags