ConnAck

Struct ConnAck 

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

Represents an MQTT CONNACK packet.

The ConnAck packet is sent by the server in response to a Connect packet from a client. It indicates whether the connection was accepted and provides session status and optional properties.

§Example

use mqute_codec::protocol::v5::{ConnAck, ConnAckProperties, ReasonCode};
use std::time::Duration;

let properties = ConnAckProperties {
    session_expiry_interval: Some(Duration::from_secs(3600)),
    receive_maximum: Some(10),
    ..Default::default()
};
let connack = ConnAck::new(
    ReasonCode::Success,
    true,
    Some(properties)
);

assert_eq!(connack.code(), ReasonCode::Success);
assert!(connack.session_present());

Implementations§

Source§

impl ConnAck

Source

pub fn new( code: ReasonCode, session_present: bool, properties: Option<ConnAckProperties>, ) -> Self

Creates a new ConnAck packet.

Source

pub fn code(&self) -> ReasonCode

Returns the reason code indicating the connection result.

Source

pub fn session_present(&self) -> bool

Returns whether the server has a previous session for this client.

Source

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

Returns the optional properties of the ConnAck packet.

Trait Implementations§

Source§

impl Clone for ConnAck

Source§

fn clone(&self) -> ConnAck

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 ConnAck

Source§

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

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

impl Decode for ConnAck

Source§

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

Decodes a ConnAck packet from a raw MQTT packet.

Source§

impl Encode for ConnAck

Source§

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

Encodes the ConnAck packet into a byte buffer.

Source§

fn payload_len(&self) -> usize

Returns the length of the ConnAck packet payload.

Source§

impl From<ConnAck> for Packet

Source§

fn from(value: ConnAck) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ConnAck

Source§

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

Source§

impl Eq for ConnAck

Source§

impl StructuralPartialEq for ConnAck

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> 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.