Struct Disconnect 

pub struct Disconnect { /* private fields */ }

Represents an MQTT v5 Disconnect packet.

The Disconnect packet is the final MQTT Control Packet sent from the Client or the Server. It indicates the reason why the Network Connection is being closed

Example

use mqute_codec::protocol::v5::{Disconnect, DisconnectProperties, ReasonCode};

let properties = DisconnectProperties {
    reason_string: Some("Reason string".to_string()),
    server_reference: Some("backup.example.com".to_string()),
    ..Default::default()
};

let disconnect = Disconnect::new(ReasonCode::Success, Some(properties.clone()));
assert_eq!(disconnect.properties(), Some(properties));

Implementations

impl Disconnect

pub fn new(code: ReasonCode, properties: Option<DisconnectProperties>) -> Self

Creates a new Disconnect packet

pub fn code(&self) -> ReasonCode

Returns the reason code

pub fn properties(&self) -> Option<DisconnectProperties>

Returns a copy of the properties (if any)

Trait Implementations

impl Clone for Disconnect

fn clone(&self) -> Disconnect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Disconnect

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

Formats the value using the given formatter.

impl Decode for Disconnect

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

Decodes a Disconnect packet from raw bytes

impl Encode for Disconnect

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

Encodes the Disconnect packet into a byte buffer

fn payload_len(&self) -> usize

Calculates the payload length

impl PartialEq for Disconnect

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

impl StructuralPartialEq for Disconnect