Struct Connect 

pub struct Connect { /* private fields */ }

Represents an MQTT Connect packet

This packet initiates a connection between client and broker and contains all necessary parameters for the session.

Example

use std::time::Duration;
use bytes::Bytes;
use mqute_codec::protocol::{v5, Credentials, Protocol, QoS};

let connect = v5::Connect::new(
    "client",
    Some(Credentials::full("user", "pass")),
    Some(v5::Will::new(
        None,
        "device/status",
        Bytes::from("disconnected"),
        QoS::ExactlyOnce,
        true
    )),
    Duration::from_secs(30),
    true
);
assert!(connect.will().is_some());
assert_eq!(connect.protocol(), Protocol::V5);
assert_eq!(connect.client_id(), "client");

Implementations

impl Connect

pub fn new<S: Into<String>>( client_id: S, credentials: Option<Credentials>, will: Option<Will>, keep_alive: Duration, clean_session: bool, ) -> Self

Creates a new Connect packet with basic parameters

Panics

Panics if the value of the “keep alive” parameter exceeds 65535

pub fn protocol(&self) -> Protocol

Returns the protocol version being used

pub fn keep_alive(&self) -> Duration

Returns the keep alive time in seconds

pub fn clean_session(&self) -> bool

Returns whether this is a clean session

pub fn client_id(&self) -> String

Returns the client identifier

pub fn credentials(&self) -> Option<Credentials>

Returns the authentication credentials if present

pub fn will(&self) -> Option<Will>

Returns the will message if present

Trait Implementations

impl Clone for Connect

fn clone(&self) -> Connect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Connect for Connect

impl Debug for Connect

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

Formats the value using the given formatter.

impl Decode for Connect

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

Decodes a raw MQTT packet into the implementing type.

impl Encode for Connect

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

Encodes the packet into the provided buffer.

fn payload_len(&self) -> usize

Returns the length of the payload in bytes.

impl Eq for Connect

impl From<Connect> for Packet

fn from(value: Connect) -> Self

Converts to this type from the input type.

impl PartialEq for Connect

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