Enum PublishFlags 

pub enum PublishFlags {
    Retain = 1,
    QoS0 = 2,
    QoS1 = 4,
    Dup = 8,
}

Flags for MQTT PUBLISH packet

Variants

Retain = 1

Retain flag

QoS0 = 2

QoS bit 0

QoS1 = 4

QoS bit 1

Dup = 8

Duplicate delivery flag

Implementations

impl PublishFlags

pub fn contains(self, flag: Self) -> bool

Check if this flag value contains the given flag

pub fn from_bits(bits: u8) -> Option<u8>

Create a flags value from a u8

pub fn decompose(bits: u8) -> Vec<Self>

Decompose a u8 value into individual flag variants

pub fn iter_flags(bits: u8) -> impl Iterator<Item = Self>

Iterate over individual flag variants set in a u8 value

impl PublishFlags

pub fn extract_qos(flags: u8) -> u8

Extract QoS value from flags

pub fn with_qos(flags: u8, qos: u8) -> u8

Create flags byte with QoS value

Trait Implementations

impl BeBytes for PublishFlags

fn to_be_bytes_buf(&self) -> Bytes

Convert to big-endian bytes as a Bytes buffer

fn to_le_bytes_buf(&self) -> Bytes

Convert to little-endian bytes as a Bytes buffer

fn encode_be_to<B: BufMut>(&self, buf: &mut B) -> Result<(), BeBytesError>

Encode directly to a buffer in big-endian format

fn encode_le_to<B: BufMut>(&self, buf: &mut B) -> Result<(), BeBytesError>

Encode directly to a buffer in little-endian format

fn field_size() -> usize

fn try_from_be_bytes(bytes: &[u8]) -> Result<(Self, usize), BeBytesError>

Try to parse a struct from big-endian bytes

fn to_be_bytes(&self) -> Vec<u8>

fn try_from_le_bytes(bytes: &[u8]) -> Result<(Self, usize), BeBytesError>

Try to parse a struct from little-endian bytes

fn to_le_bytes(&self) -> Vec<u8>

impl BitAnd<PublishFlags> for u8

type Output = u8

The resulting type after applying the & operator.

fn bitand(self, rhs: PublishFlags) -> Self::Output

Performs the & operation.

impl BitAnd<u8> for PublishFlags

type Output = u8

The resulting type after applying the & operator.

fn bitand(self, rhs: u8) -> Self::Output

Performs the & operation.

impl BitAnd for PublishFlags

type Output = u8

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr<PublishFlags> for u8

type Output = u8

The resulting type after applying the | operator.

fn bitor(self, rhs: PublishFlags) -> Self::Output

Performs the | operation.

impl BitOr<u8> for PublishFlags

type Output = u8

The resulting type after applying the | operator.

fn bitor(self, rhs: u8) -> Self::Output

Performs the | operation.

impl BitOr for PublishFlags

type Output = u8

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor<PublishFlags> for u8

type Output = u8

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: PublishFlags) -> Self::Output

Performs the ^ operation.

impl BitXor<u8> for PublishFlags

type Output = u8

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u8) -> Self::Output

Performs the ^ operation.

impl BitXor for PublishFlags

type Output = u8

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for PublishFlags

fn clone(&self) -> PublishFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishFlags

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

Formats the value using the given formatter.

impl Not for PublishFlags

type Output = u8

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for PublishFlags

fn eq(&self, other: &PublishFlags) -> 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 TryFrom<u8> for PublishFlags

type Error = BeBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for PublishFlags

impl Eq for PublishFlags

impl StructuralPartialEq for PublishFlags