Struct mqttrs::Pid

pub struct Pid(_);

Packet Identifier.

For packets with QoS::AtLeastOne or QoS::ExactlyOnce delivery.

#[derive(Default)]
struct Session {
   pid: Pid,
}
impl Session {
   pub fn next_pid(&mut self) -> Pid {
       self.pid = self.pid + 1;
       self.pid
   }
}

let mut sess = Session::default();
assert_eq!(2, sess.next_pid().get());
assert_eq!(Pid::try_from(3).unwrap(), sess.next_pid());

The spec (MQTT-2.3.1-1, MQTT-2.2.1-3) disallows a pid of 0.

Methods

impl Pid

pub fn new() -> Self

Returns a new Pid with value 1.

pub fn get(self) -> u16

Get the Pid as a raw u16.

Trait Implementations

impl Add<u16> for Pid

type Output = Pid

The resulting type after applying the + operator.

fn add(self, u: u16) -> Pid

Adding a u16 to a Pid will wrap around and avoid 0.

impl Clone for Pid

fn clone(&self) -> Pid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Pid

impl Debug for Pid

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

Formats the value using the given formatter.

impl Default for Pid

fn default() -> Pid

Returns the "default value" for a type.

impl Eq for Pid

impl From<Pid> for u16

fn from(p: Pid) -> Self

Convert Pid to u16.

impl Hash for Pid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Pid

fn cmp(&self, other: &Pid) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Pid> for Pid

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

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

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

This method tests for !=.

impl PartialOrd<Pid> for Pid

fn partial_cmp(&self, other: &Pid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Pid) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Pid) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Pid) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Pid) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Pid

impl StructuralPartialEq for Pid

impl Sub<u16> for Pid

type Output = Pid

The resulting type after applying the - operator.

fn sub(self, u: u16) -> Pid

Adding a u16 to a Pid will wrap around and avoid 0.

impl TryFrom<u16> for Pid

type Error = Error

The type returned in the event of a conversion error.

fn try_from(u: u16) -> Result<Self, Error>

Convert u16 to Pid. Will fail for value 0.