Struct sage_mqtt::Auth

pub struct Auth {
    pub reason_code: ReasonCode,
    pub authentication: Authentication,
    pub reason_string: Option<String>,
    pub user_properties: Vec<(String, String)>,
}

The Auth packet is used for enhanced authentication upon connection. When a client connects to a server, it can initiates an authentication using the Authentication structure. Then the client and server exchange Auth packets until either the the client sends a Disconnect packet or the server respond with a Connack packet.

Fields

reason_code: ReasonCode

The packet reason code. Can be any of:

• Success: The authentication is successful
• ReAuthenticate (client only): Ask for a new authentication
• ContinueAuthentication: Continue the authentication with another step

authentication: Authentication

The Authentication data which consists in an authentication method and optionnaly data.

reason_string: Option<String>

Optional reason string sent by the server.

user_properties: Vec<(String, String)>

General purpose user properties.

Trait Implementations

impl Clone for Auth

pub fn clone(&self) -> Auth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl Default for Auth

pub fn default() -> Self

Returns the "default value" for a type.

impl From<Auth> for Packet

pub fn from(control: Auth) -> Self

Performs the conversion.

impl PartialEq<Auth> for Auth

pub fn eq(&self, other: &Auth) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Auth) -> bool

This method tests for !=.

impl StructuralPartialEq for Auth