Struct AuthPacket 

pub struct AuthPacket {
    pub reason_code: ReasonCode,
    pub properties: Properties,
}

AUTH packet for MQTT v5.0 enhanced authentication

Fields

reason_code: ReasonCode

Reason code indicating the result of the authentication

properties: Properties

Properties associated with the authentication

Implementations

impl AuthPacket

pub fn new(reason_code: ReasonCode) -> Self

Creates a new AUTH packet

pub fn with_properties(reason_code: ReasonCode, properties: Properties) -> Self

Creates a new AUTH packet with properties

pub fn continue_authentication( auth_method: String, auth_data: Option<Vec<u8>>, ) -> Result<Self>

Creates an AUTH packet for continuing authentication

Errors

Returns an error if the operation fails

pub fn re_authenticate( auth_method: String, auth_data: Option<Vec<u8>>, ) -> Result<Self>

Creates an AUTH packet for re-authentication

Errors

Returns an error if the operation fails

pub fn success(auth_method: String) -> Result<Self>

Creates a successful authentication response

Errors

Returns an error if the operation fails

pub fn failure( reason_code: ReasonCode, reason_string: Option<String>, ) -> Result<Self>

Creates an authentication failure response

Errors

Returns an error if the operation fails

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

Gets the authentication method from properties

pub fn authentication_data(&self) -> Option<&[u8]>

Gets the authentication data from properties

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

Gets the reason string from properties

pub fn validate(&self) -> Result<()>

Validates the AUTH packet

Errors

Returns an error if the operation fails

Trait Implementations

impl Clone for AuthPacket

fn clone(&self) -> AuthPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthPacket

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

Formats the value using the given formatter.

impl MqttPacket for AuthPacket

fn packet_type(&self) -> PacketType

Returns the packet type

fn encode_body<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes the packet body (without fixed header)

fn decode_body<B: Buf>(buf: &mut B, fixed_header: &FixedHeader) -> Result<Self>

Decodes the packet body (without fixed header)

fn flags(&self) -> u8

Returns the fixed header flags

fn encode<B: BufMut>(&self, buf: &mut B) -> Result<()>

Encodes the complete packet (with fixed header)

impl PartialEq for AuthPacket

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

impl StructuralPartialEq for AuthPacket