Struct MqttBuilder 

pub struct MqttBuilder { /* private fields */ }

Builder for MQTT packets.

By default, builds a PINGREQ message (\xC0\x00).

Implementations

impl MqttBuilder

pub fn new() -> Self

Create a new MQTT builder. Defaults to PINGREQ (\xC0\x00).

pub fn connect(self) -> Self

Set message type to CONNECT (1).

pub fn connack(self) -> Self

Set message type to CONNACK (2).

pub fn publish(self) -> Self

Set message type to PUBLISH (3).

pub fn puback(self) -> Self

Set message type to PUBACK (4).

pub fn pubrec(self) -> Self

Set message type to PUBREC (5).

pub fn pubrel(self) -> Self

Set message type to PUBREL (6).

pub fn pubcomp(self) -> Self

Set message type to PUBCOMP (7).

pub fn subscribe(self) -> Self

Set message type to SUBSCRIBE (8).

pub fn suback(self) -> Self

Set message type to SUBACK (9).

pub fn unsubscribe(self) -> Self

Set message type to UNSUBSCRIBE (10).

pub fn unsuback(self) -> Self

Set message type to UNSUBACK (11).

pub fn pingreq(self) -> Self

Set message type to PINGREQ (12, the default).

pub fn pingresp(self) -> Self

Set message type to PINGRESP (13).

pub fn disconnect(self) -> Self

Set message type to DISCONNECT (14).

pub fn msg_type(self, t: u8) -> Self

Set the raw message type value.

pub fn dup(self, val: bool) -> Self

Set the DUP flag.

pub fn qos(self, val: u8) -> Self

Set the QoS level.

pub fn retain(self, val: bool) -> Self

Set the RETAIN flag.

pub fn proto_name<T: Into<Vec<u8>>>(self, name: T) -> Self

Set the protocol name (default: “MQTT”).

pub fn proto_level(self, level: u8) -> Self

Set the protocol level (default: 4 for MQTT 3.1.1).

pub fn clean_session(self, val: bool) -> Self

Set the clean session flag.

pub fn will(self, topic: &[u8], msg: &[u8], qos: u8, retain: bool) -> Self

Set the will flag and optionally will topic/message.

pub fn username<T: Into<Vec<u8>>>(self, name: T) -> Self

Set the username.

pub fn password<T: Into<Vec<u8>>>(self, pass: T) -> Self

Set the password.

pub fn keep_alive(self, secs: u16) -> Self

Set the keep alive value (seconds).

pub fn client_id<T: Into<Vec<u8>>>(self, id: T) -> Self

Set the client ID.

pub fn topic<T: Into<Vec<u8>>>(self, t: T) -> Self

Set the topic for PUBLISH.

pub fn msg_id(self, id: u16) -> Self

Set the message ID.

pub fn payload<T: Into<Vec<u8>>>(self, data: T) -> Self

Set the payload/value bytes.

pub fn add_topic(self, filter: &[u8], qos: u8) -> Self

Add a topic filter with requested QoS for SUBSCRIBE.

pub fn retcodes<T: Into<Vec<u8>>>(self, codes: T) -> Self

Set the return codes for SUBACK.

pub fn sess_present(self, val: u8) -> Self

Set the session present flag for CONNACK.

pub fn ret_code(self, code: u8) -> Self

Set the return code for CONNACK.

pub fn remaining_size(&self) -> usize

Compute the size of the variable header + payload (the remaining length).

pub fn header_size(&self) -> usize

Compute the total header size (fixed header bytes only).

pub fn packet_size(&self) -> usize

Compute the total packet size.

pub fn build(&self) -> Vec<u8>

Serialize the MQTT packet into bytes.

Trait Implementations

impl Clone for MqttBuilder

fn clone(&self) -> MqttBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MqttBuilder

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

Formats the value using the given formatter.

impl Default for MqttBuilder

fn default() -> Self

Returns the “default value” for a type.

impl IntoLayerStackEntry for MqttBuilder

fn into_layer_stack_entry(self) -> LayerStackEntry