Struct Subscribe

pub struct Subscribe { /* private fields */ }

Represents an MQTT Subscribe packet.

Example

use mqute_codec::protocol::v4::{Subscribe, TopicQosFilter};
use mqute_codec::protocol::QoS;

let filters = vec![
    TopicQosFilter::new("topic1", QoS::AtLeastOnce),
    TopicQosFilter::new("topic2", QoS::ExactlyOnce),
];
let subscribe = Subscribe::new(123, filters);
assert_eq!(subscribe.packet_id(), 123);

Implementations

impl Subscribe

pub fn new<T: IntoIterator<Item = TopicQosFilter>>( packet_id: u16, filters: T, ) -> Self

Creates a new Subscribe packet.

Panics

Panics if packet_id is zero.

pub fn packet_id(&self) -> u16

Returns the packet ID of the Subscribe packet.

pub fn filters(&self) -> TopicQosFilters

Returns the list of topic filters and their requested QoS levels.

Trait Implementations

impl Clone for Subscribe

fn clone(&self) -> Subscribe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscribe

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

Formats the value using the given formatter.

impl Decode for Subscribe

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

Decodes a Subscribe packet from a raw MQTT packet.

impl Encode for Subscribe

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

Encodes the Subscribe packet into a byte buffer.

fn payload_len(&self) -> usize

Returns the length of the Subscribe packet payload.

impl PartialEq for Subscribe

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

impl StructuralPartialEq for Subscribe