Struct Client

Source
pub struct Client;
Expand description

MQTT Client role type

Represents an MQTT client that connects to MQTT brokers. Clients can:

  • Establish connections to brokers using CONNECT packets
  • Publish messages to topics
  • Subscribe to topic filters to receive messages
  • Send heartbeat PINGREQ packets
  • Gracefully disconnect using DISCONNECT packets

This is a zero-sized type used purely for compile-time role identification. The actual client behavior is implemented in the connection logic that uses this role type as a generic parameter.

§Protocol Restrictions

When using the Client role, certain MQTT packets are restricted:

  • Cannot send CONNACK (connection acknowledgment)
  • Cannot send SUBACK (subscription acknowledgment)
  • Cannot send UNSUBACK (unsubscription acknowledgment)
  • Cannot send PINGRESP (ping response)

§Examples

use mqtt_protocol_core::mqtt;

// Client role is typically used as a generic parameter
type ClientConnection = mqtt::connection::GenericConnection<mqtt::connection::Client, u16>;

// Role constants can be checked at compile time
assert_eq!(mqtt::connection::Client::IS_CLIENT, true);
assert_eq!(mqtt::connection::Client::IS_SERVER, false);

Trait Implementations§

Source§

impl<PacketIdType> RecvBehavior<Client, PacketIdType> for GenericConnection<Client, PacketIdType>
where PacketIdType: IsPacketId,

Source§

fn recv(&mut self, data: &mut Cursor<&[u8]>) -> Vec<GenericEvent<PacketIdType>>

Source§

impl RoleType for Client

Implementation of RoleType for Client

Configures the Client role type with the appropriate role flags. Only the IS_CLIENT flag is set to true, clearly identifying this type as representing an MQTT client role.

Source§

const IS_CLIENT: bool = true

Indicates if this role type represents an MQTT client Read more
Source§

const IS_SERVER: bool = false

Indicates if this role type represents an MQTT server/broker Read more
Source§

const IS_ANY: bool = false

Indicates if this role type can represent any MQTT role Read more
Source§

impl<PacketIdType> Sendable<Client, PacketIdType> for GenericPacket<PacketIdType>
where PacketIdType: IsPacketId,

Source§

fn dispatch_send( self, connection: &mut GenericConnection<Client, PacketIdType>, ) -> Vec<GenericEvent<PacketIdType>>

Source§

impl SendableRole<Client> for Auth

Source§

impl SendableRole<Client> for Connect

Source§

impl SendableRole<Client> for Connect

Source§

impl SendableRole<Client> for Disconnect

Source§

impl SendableRole<Client> for Disconnect

Source§

impl<PacketIdType> SendableRole<Client> for GenericPuback<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPuback<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubcomp<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubcomp<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPublish<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPublish<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubrec<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubrec<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubrel<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericPubrel<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericSubscribe<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericSubscribe<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericUnsubscribe<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl<PacketIdType> SendableRole<Client> for GenericUnsubscribe<PacketIdType>
where PacketIdType: IsPacketId,

Source§

impl SendableRole<Client> for Pingreq

Source§

impl SendableRole<Client> for Pingreq

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

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> AsConcrete<T> for T

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> 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> IntoConcreteOwned<T> for T

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