Struct SubAck

pub struct SubAck { /* private fields */ }

The SubAck packet is sent by the server to the client to confirm receipt and processing of a subscription request. It contains return codes indicating the maximum QoS level granted for each requested subscription.

Examples

use mqute_codec::protocol::QoS;
use mqute_codec::protocol::v4::{ReturnCode, SubAck};

// Single subscription
let suback = SubAck::new(1, vec![ReturnCode::Success(QoS::AtMostOnce)]);

let codes = suback.codes();
assert_eq!(codes[0], ReturnCode::Success(QoS::AtMostOnce));

Implementations

impl SubAck

pub fn new<I: IntoIterator<Item = ReturnCode>>(packet_id: u16, codes: I) -> Self

Creates a new SubAck packet

Panics

Panics if packet_id is 0 (invalid packet identifier)

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

Returns the subscription return codes

Each code indicates the result of the corresponding subscription request:

• Success variants contain the granted QoS level
• Failure indicates the subscription was not accepted

pub fn packet_id(&self) -> u16

Returns the packet identifier

This matches the identifier from the corresponding Subscribe packet

Trait Implementations

impl Clone for SubAck

fn clone(&self) -> SubAck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubAck

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

Formats the value using the given formatter.

impl Decode for SubAck

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

Decodes a raw MQTT packet into the implementing type.

impl Encode for SubAck

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

Encodes the packet into the provided buffer.

fn payload_len(&self) -> usize

Returns the length of the payload in bytes.

impl PartialEq for SubAck

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

impl StructuralPartialEq for SubAck