Struct Unsubscribe 

pub struct Unsubscribe<'a> {
    pub packet_id: PacketId,
    pub properties: &'a UnsubscribeProperties,
    pub topic_filters: &'a TopicFilters,
}

UNSUBSCRIBE packet requesting removal of topic filter subscriptions.

Fields

packet_id: PacketId

Packet identifier.

properties: &'a UnsubscribeProperties

UNSUBSCRIBE properties.

topic_filters: &'a TopicFilters

Topic filter entries in this packet.

Implementations

impl<'a> Unsubscribe<'a>

pub const fn new( packet_id: PacketId, properties: &'a UnsubscribeProperties, topic_filters: &'a TopicFilters, ) -> Self

Creates an UNSUBSCRIBE packet from a topic filter payload.

pub const fn encoded_len(&self) -> usize

Returns the encoded size of the variable header + payload in bytes.

pub const fn encode(&self, w: &mut Writer<'_>) -> Result<(), EncodeError>

Encodes the UNSUBSCRIBE variable header + payload into the writer.

Errors

Returns EncodeError::InsufficientSpace if the writer does not have enough capacity.

pub const fn decode(r: &mut Reader<'a>) -> Result<Self, DecodeError>

Decodes an UNSUBSCRIBE packet from the reader.

Errors

Returns DecodeError if the data is malformed, the packet ID is zero, properties contain disallowed IDs, or the payload is invalid.

Trait Implementations

impl<'a> Clone for Unsubscribe<'a>

fn clone(&self) -> Unsubscribe<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Unsubscribe<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Unsubscribe<'a>

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

impl<'a> StructuralPartialEq for Unsubscribe<'a>