Enum sage_mqtt::Packet[−][src]

pub enum Packet {
Show 15 variants
    Connect(Connect),
    ConnAck(ConnAck),
    Publish(Publish),
    PubAck(PubAck),
    PubRec(PubRec),
    PubRel(PubRel),
    PubComp(PubComp),
    Subscribe(Subscribe),
    SubAck(SubAck),
    UnSubscribe(UnSubscribe),
    UnSubAck(UnSubAck),
    PingReq,
    PingResp,
    Disconnect(Disconnect),
    Auth(Auth),
}

Expand description

The standard type to manipulate a AsyncRead/AsyncWrite-able MQTT packet. Each packet is an enum value with its own type.

Variants

Connect(Connect)

CONNECT MQTT packet. Opens a connection request.

Tuple Fields of Connect

0: Connect

ConnAck(ConnAck)

CONNACK MQTT packet. Aknowledge a connectio request.

Tuple Fields of ConnAck

0: ConnAck

Publish(Publish)

PUBLISH MQTT packet. Delivery a message to or from a server.

Tuple Fields of Publish

0: Publish

PubAck(PubAck)

PUBACK MQTT packet. Ackowledge a QoS 1 or QoS 2 message.

Tuple Fields of PubAck

0: PubAck

PubRec(PubRec)

PUBREC MQTT packet. Ackowledge a QoS 2 message.

Tuple Fields of PubRec

0: PubRec

PubRel(PubRel)

PUBREL MQTT packet. Ackowledge a QoS 2 message.

Tuple Fields of PubRel

0: PubRel

PubComp(PubComp)

PUBCOMP MQTT packet. Ackowledge a QoS 2 message.

Tuple Fields of PubComp

0: PubComp

Subscribe(Subscribe)

SUBSCRIBE MQTT packet. Subscribe a client to topics.

SubAck(SubAck)

SUBACK MQTT packet. Acknowledge a client SUBSCRIBE packet.

Tuple Fields of SubAck

0: SubAck

UnSubscribe(UnSubscribe)

UNSUBSCRIBE MQTT packet. Unsubscribe a client from topics.

Tuple Fields of UnSubscribe

0: UnSubscribe

UnSubAck(UnSubAck)

UNSUBACK MQTT packet. Acknowledge a client UNSUBSCRIBE packet.

Tuple Fields of UnSubAck

0: UnSubAck

PingReq

PINGREQ MQTT packet. Send a ping request.

PingResp

PINGRESP MQTT packet. Respond to a ping request.

Disconnect(Disconnect)

DISCONNECT MQTT packet. Disconnect a connextion and optionally a session.

Tuple Fields of Disconnect

0: Disconnect

Auth(Auth)

AUTH MQTT packet. Performs authentication exchanges between clients and server.

Tuple Fields of Auth

0: Auth

Implementations

impl Packet

pub async fn encode<W: AsyncWrite + Unpin>(
self,
writer: &mut W
) -> SageResult<usize>

Write the entire Packet to writer, returning the number of bytes written. In case of failure, the operation will return any MQTT-related error, or std::io::Error.

pub async fn decode<R: AsyncRead + Unpin>(reader: &mut R) -> SageResult<Self>

Read a control packet from reader, returning a new Packet. In case of failure, the operation will return any MQTT-related error, or std::io::Error.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

impl Debug for Packet

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

Formats the value using the given formatter. Read more

impl Display for Packet

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

Formats the value using the given formatter. Read more

impl From<Auth> for Packet

fn from(control: Auth) -> Self

Performs the conversion.

impl From<ConnAck> for Packet

fn from(control: ConnAck) -> Self

Performs the conversion.

impl From<Connect> for Packet

fn from(control: Connect) -> Self

Performs the conversion.

impl From<Disconnect> for Packet

fn from(control: Disconnect) -> Self

Performs the conversion.

impl From<PingReq> for Packet

fn from(_: PingReq) -> Self

Performs the conversion.

impl From<PingResp> for Packet

fn from(_: PingResp) -> Self

Performs the conversion.

impl From<PubAck> for Packet

fn from(control: PubAck) -> Self

Performs the conversion.

impl From<PubComp> for Packet

fn from(control: PubComp) -> Self

Performs the conversion.

impl From<PubRec> for Packet

fn from(control: PubRec) -> Self

Performs the conversion.

impl From<PubRel> for Packet

fn from(control: PubRel) -> Self

Performs the conversion.

impl From<Publish> for Packet

fn from(control: Publish) -> Self

Performs the conversion.

impl From<SubAck> for Packet

fn from(control: SubAck) -> Self

Performs the conversion.

impl From<Subscribe> for Packet

fn from(control: Subscribe) -> Self

Performs the conversion.

impl From<UnSubAck> for Packet

fn from(control: UnSubAck) -> Self

Performs the conversion.

impl From<UnSubscribe> for Packet

fn from(control: UnSubscribe) -> Self

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for Packet

impl Send for Packet

impl Sync for Packet

impl Unpin for Packet

impl UnwindSafe for Packet

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.