Struct ConnectPacket 

pub struct ConnectPacket { /* private fields */ }

ConnectPacket consists of three parts:

• FixedHeader
• VariableHeader
• Payload Note that fixed header part is same in all packets so that we just ignore it.

Basic struct of ConnectPacket is as below:

 7                          0
+----------------------------+
| Fixed header               |
|                            |
+----------------------------+
| Protocol name              |
|                            |
+----------------------------+
| Protocol level             |
+----------------------------+
| Connect flags              |
+----------------------------+
| Keep alive                 |
|                            |
+----------------------------+
| Client id length           |
|                            |
+----------------------------+
| Client id string ...       |
+----------------------------+
| Will topic length          |
|                            |
+----------------------------+
| Will topic string ...      |
+----------------------------+
| Will message length        |
|                            |
+----------------------------+
| Will message bytes ...     |
+----------------------------+
| Username length            |
|                            |
+----------------------------+
| Username string ...        |
+----------------------------+
| Password length            |
|                            |
+----------------------------+
| Password bytes ...         |
+----------------------------+

Implementations

impl ConnectPacket

pub fn new(client_id: &str) -> Result<Self, EncodeError>

Create a new connect packet with client_id.

Errors

Returns error if client_id is invalid.

pub fn new_v3(client_id: &str) -> Result<Self, EncodeError>

Create a new connect packet with client_id with mqtt 3.1 protocol.

Errors

Returns error if client_id is invalid.

pub fn set_protcol_level( &mut self, level: ProtocolLevel, ) -> Result<(), EncodeError>

Update protocol level.

Errors

Returns error if set protocol to MQTT v5.

pub const fn protocol_level(&self) -> ProtocolLevel

Get current protocol level.

pub fn set_connect_flags(&mut self, flags: ConnectFlags) -> &Self

Update connect flags

pub const fn connect_flags(&self) -> &ConnectFlags

Get current connect flags.

pub fn set_keep_alive(&mut self, keep_alive: u16) -> &mut Self

Update keep alive value in milliseconds.

pub const fn keep_alive(&self) -> u16

Get current keep alive value.

pub fn set_client_id( &mut self, client_id: &str, ) -> Result<&mut Self, EncodeError>

Update client id.

Errors

Returns error if client_id is invalid.

pub fn client_id(&self) -> &str

Get current client id.

pub fn set_username(&mut self, username: &str) -> Result<&mut Self, EncodeError>

Update username value.

Errors

Returns error if username contains invalid chars or too long.

pub fn username(&self) -> &str

Get current username value.

pub fn set_password( &mut self, password: &[u8], ) -> Result<&mut Self, EncodeError>

Update password value.

Errors

Returns error if password is too long.

pub fn password(&self) -> &[u8]

Get current password value.

pub fn set_will_topic(&mut self, topic: &str) -> Result<&mut Self, EncodeError>

Update will-topic.

Errors

Returns error if topic is invalid.

pub fn will_topic(&self) -> Option<&str>

Get current will-topic value.

pub fn set_will_message( &mut self, message: &[u8], ) -> Result<&mut Self, EncodeError>

Update will-message.

Errors

Returns error if message is too long.

pub fn will_message(&self) -> &[u8]

Get current will-message value.

Trait Implementations

impl Clone for ConnectPacket

fn clone(&self) -> ConnectPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectPacket

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

Formats the value using the given formatter.

impl DecodePacket for ConnectPacket

fn decode(ba: &mut ByteArray<'_>) -> Result<Self, DecodeError>

Decode byte array into a mqtt packet.

impl Default for ConnectPacket

fn default() -> ConnectPacket

Returns the “default value” for a type.

impl EncodePacket for ConnectPacket

fn encode(&self, v: &mut Vec<u8>) -> Result<usize, EncodeError>

Encode packets into byte array.

impl Packet for ConnectPacket

fn packet_type(&self) -> PacketType

fn bytes(&self) -> Result<usize, VarIntError>

Get byte length in packet.

impl PartialEq for ConnectPacket

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

impl StructuralPartialEq for ConnectPacket