Skip to main content

Flags

Struct Flags 

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

Packet header types and fixed header implementation 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§

Source§

impl Flags

Source

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);
Source

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§

Source§

impl Clone for Flags

Source§

fn clone(&self) -> Flags

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Flags

Source§

impl Debug for Flags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Flags

Source§

fn default() -> Self

Creates default Flags with:

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

impl Eq for Flags

Source§

impl PartialEq for Flags

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Flags

Auto Trait Implementations§

§

impl Freeze for Flags

§

impl RefUnwindSafe for Flags

§

impl Send for Flags

§

impl Sync for Flags

§

impl Unpin for Flags

§

impl UnsafeUnpin for Flags

§

impl UnwindSafe for Flags

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.