Struct sage_mqtt::Subscribe

pub struct Subscribe {
    pub packet_identifier: u16,
    pub subscription_identifier: Option<u32>,
    pub user_properties: Vec<(String, String)>,
    pub subscriptions: Vec<(String, SubscriptionOptions)>,
}

The subscribe packet is a request from the client to listen to one or more topics.

Fields

packet_identifier: u16

The packet identifier is used to identify the message throughout the communication.

subscription_identifier: Option<u32>

Optional identifier used to represent the subscription in nextcoming mmessages.

user_properties: Vec<(String, String)>

General purpose user properies

subscriptions: Vec<(String, SubscriptionOptions)>

The list of topics to subscribe to with options. Each topics can use wildcards.

Implementations

impl Subscribe

pub async fn write<'_, W: AsyncWrite + Unpin>(
    self,
    writer: &'_ mut W
) -> SageResult<usize>

Write the Subscribe body of a packet, returning the written size in bytes in case of success.

pub async fn read<'_, R: AsyncRead + Unpin>(
    reader: &'_ mut R,
    remaining_size: usize
) -> SageResult<Self>

Read the Subscribe body from reader, retuning it in case of success.

Trait Implementations

impl Clone for Subscribe

fn clone(&self) -> Subscribe

Returns a copy 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 Default for Subscribe

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Subscribe> for Subscribe

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Subscribe) -> bool

This method tests for !=.

impl StructuralPartialEq for Subscribe