Unsubscribe

Struct Unsubscribe 

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

Represents an MQTT Unsubscribe packet.

§Example

use mqute_codec::protocol::TopicFilters;
use mqute_codec::protocol::v4::Unsubscribe;

let unsubscribe = Unsubscribe::new(1234, vec!["topic1", "topic2"]);

let filters = TopicFilters::new(vec!["topic1", "topic2"]);

assert_eq!(unsubscribe.packet_id(), 1234u16);
assert_eq!(unsubscribe.filters(), filters);

Implementations§

Source§

impl Unsubscribe

Source

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

Creates a new Unsubscribe packet.

§Panics

Panics if:

  • packet_id is zero.
  • The topic filters are invalid according to MQTT topic naming rules.
Source

pub fn packet_id(&self) -> u16

Returns the packet ID of the Unsubscribe packet.

Source

pub fn filters(&self) -> TopicFilters

Returns the list of topic filters to unsubscribe from.

Trait Implementations§

Source§

impl Clone for Unsubscribe

Source§

fn clone(&self) -> Unsubscribe

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 Unsubscribe

Source§

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

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

impl Decode for Unsubscribe

Source§

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

Decodes an Unsubscribe packet from a raw MQTT packet.

Source§

impl Encode for Unsubscribe

Source§

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

Encodes the Unsubscribe packet into a byte buffer.

Source§

fn payload_len(&self) -> usize

Returns the length of the payload in bytes. Read more
Source§

impl PartialEq for Unsubscribe

Source§

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

Source§

impl StructuralPartialEq for Unsubscribe

Auto Trait Implementations§

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.