Auth

Struct Auth 

Source
pub struct Auth { /* private fields */ }
Expand description

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§

Source§

impl Auth

Source

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

Creates a new Auth packet.

Source

pub fn code(&self) -> ReasonCode

Returns the reason code of the Auth packet.

Source

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

Returns the properties of the Auth packet.

Trait Implementations§

Source§

impl Clone for Auth

Source§

fn clone(&self) -> Auth

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Auth

Source§

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

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

impl Decode for Auth

Source§

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

Decodes an Auth packet from a raw MQTT packet.

Source§

impl Encode for Auth

Source§

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

Encodes the Auth packet into a byte buffer.

Source§

fn payload_len(&self) -> usize

Returns the length of the Auth packet payload.

Source§

impl PartialEq for Auth

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Auth

Source§

impl StructuralPartialEq for Auth

Auto Trait Implementations§

§

impl !Freeze for Auth

§

impl RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin for Auth

§

impl UnwindSafe for Auth

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> Encoded for T
where T: Encode,

Source§

fn encoded_len(&self) -> usize

Calculates the total encoded length of the packet. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.