Skip to main content

AuthPacket

Struct AuthPacket 

Source
pub struct AuthPacket {
    pub reason_code: ReasonCode,
    pub properties: Properties,
}
Expand description

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§

Source§

impl AuthPacket

Source

pub fn new(reason_code: ReasonCode) -> Self

Creates a new AUTH packet

Source

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

Creates a new AUTH packet with properties

Source

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

Source

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

Source

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

Creates a successful authentication response

§Errors

Returns an error if the operation fails

Source

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

Source

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

Gets the authentication method from properties

Source

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

Gets the authentication data from properties

Source

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

Gets the reason string from properties

Source

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

Validates the AUTH packet

§Errors

Returns an error if the operation fails

Trait Implementations§

Source§

impl Clone for AuthPacket

Source§

fn clone(&self) -> AuthPacket

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuthPacket

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for AuthPacket

Source§

impl MqttPacket for AuthPacket

Source§

fn packet_type(&self) -> PacketType

Returns the packet type
Source§

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

Encodes the packet body (without fixed header) Read more
Source§

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

Decodes the packet body (without fixed header) Read more
Source§

fn flags(&self) -> u8

Returns the fixed header flags
Source§

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

Encodes the complete packet (with fixed header) Read more
Source§

impl PartialEq for AuthPacket

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AuthPacket

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more