Struct Auth 

pub struct Auth { /* private fields */ }

Represents an MQTT AUTH packet.

The Auth packet is used in the MQTT v5 protocol for enhanced authentication and re-authentication.

It includes a reason code and optional properties.

Example

use bytes::Bytes;
use mqute_codec::protocol::v5::{Auth, AuthProperties, ReasonCode};

let properties = AuthProperties {
    auth_method: Some("method".to_string()),
    auth_data: Some(Bytes::from("data")),
    reason_string: Some("reason".to_string()),
    user_properties: vec![("key".to_string(), "value".to_string())],
};
let auth = Auth::new(ReasonCode::ContinueAuthentication, Some(properties));
assert_eq!(auth.code(), ReasonCode::ContinueAuthentication);

Implementations

impl Auth

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

Creates a new Auth packet.

pub fn code(&self) -> ReasonCode

Returns the reason code of the Auth packet.

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

Returns the properties of the Auth packet.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl Decode for Auth

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

Decodes an Auth packet from a raw MQTT packet.

impl Encode for Auth

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

Encodes the Auth packet into a byte buffer.

fn payload_len(&self) -> usize

Returns the length of the Auth packet payload.

impl From<Auth> for Packet

fn from(value: Auth) -> Self

Converts to this type from the input type.

impl PartialEq for Auth

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

impl Eq for Auth

impl StructuralPartialEq for Auth