SubAck

Struct SubAck 

Source
pub struct SubAck { /* private fields */ }
Expand description

Represents an MQTT v5 SubAck packet

The SubAck packet is sent by the server to acknowledge receipt and processing of a Subscribe packet. It contains:

  • Packet Identifier matching the Subscribe packet
  • List of return codes indicating granted QoS levels or errors
  • Optional properties (v5 only)

§Example

use mqute_codec::protocol::Codes;
use mqute_codec::protocol::v5::{SubAck, ReasonCode};

// Successful subscription with different QoS levels
let suback = SubAck::new(
    1234,
    None,
    vec![
        ReasonCode::GrantedQos0,
        ReasonCode::GrantedQos2,
        ReasonCode::GrantedQos1
    ],
);

assert_eq!(suback.packet_id(), 1234u16);
let codes = Codes::new(vec![
                            ReasonCode::GrantedQos0,
                            ReasonCode::GrantedQos2,
                            ReasonCode::GrantedQos1
                        ]);
assert_eq!(suback.codes(), codes);

Implementations§

Source§

impl SubAck

Source

pub fn new<T>( packet_id: u16, properties: Option<SubAckProperties>, codes: T, ) -> Self
where T: IntoIterator<Item = ReasonCode>,

Creates a new SubAck packet

§Panics
  • If no reason codes are provided
  • If any reason code is invalid for SubAck
Source

pub fn packet_id(&self) -> u16

Returns the packet identifier

Source

pub fn codes(&self) -> Codes<ReasonCode>

Returns the list of reason codes

Source

pub fn properties(&self) -> Option<SubAckProperties>

Returns a copy of the properties (if any)

Trait Implementations§

Source§

impl Clone for SubAck

Source§

fn clone(&self) -> SubAck

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubAck

Source§

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

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

impl Decode for SubAck

Source§

fn decode(packet: RawPacket) -> Result<Self, Error>

Decodes a SubAck packet from raw bytes

Source§

impl Encode for SubAck

Source§

fn encode(&self, buf: &mut BytesMut) -> Result<(), Error>

Encodes the SubAck packet into a byte buffer

Source§

fn payload_len(&self) -> usize

Calculates the total packet length

Source§

impl From<SubAck> for Packet

Source§

fn from(value: SubAck) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for SubAck

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 Eq for SubAck

Source§

impl StructuralPartialEq for SubAck

Source§

impl SubAck for SubAck

Auto Trait Implementations§

§

impl Freeze for SubAck

§

impl RefUnwindSafe for SubAck

§

impl Send for SubAck

§

impl Sync for SubAck

§

impl Unpin for SubAck

§

impl UnwindSafe for SubAck

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> Encoded for T
where T: Encode,

Source§

fn encoded_len(&self) -> usize

Calculates the total encoded length of the packet. 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.