Enum ntex_mqtt::v3::codec::Packet

pub enum Packet {
    Connect(Connect),
    ConnectAck {
        session_present: bool,
        return_code: ConnectAckReason,
    },
    Publish(Publish),
    PublishAck {
        packet_id: NonZeroU16,
    },
    PublishReceived {
        packet_id: NonZeroU16,
    },
    PublishRelease {
        packet_id: NonZeroU16,
    },
    PublishComplete {
        packet_id: NonZeroU16,
    },
    Subscribe {
        packet_id: NonZeroU16,
        topic_filters: Vec<(ByteString, QoS)>,
    },
    SubscribeAck {
        packet_id: NonZeroU16,
        status: Vec<SubscribeReturnCode>,
    },
    Unsubscribe {
        packet_id: NonZeroU16,
        topic_filters: Vec<ByteString>,
    },
    UnsubscribeAck {
        packet_id: NonZeroU16,
    },
    PingRequest,
    PingResponse,
    Disconnect,
}

MQTT Control Packets

Variants

Connect(Connect)

Client request to connect to Server

ConnectAck

Connect acknowledgment

Fields of ConnectAck

session_present: bool

enables a Client to establish whether the Client and Server have a consistent view about whether there is already stored Session state.

return_code: ConnectAckReason

Publish(Publish)

Publish message

PublishAck

Publish acknowledgment

Fields of PublishAck

packet_id: NonZeroU16

Packet Identifier

PublishReceived

Publish received (assured delivery part 1)

Fields of PublishReceived

packet_id: NonZeroU16

Packet Identifier

PublishRelease

Publish release (assured delivery part 2)

Fields of PublishRelease

packet_id: NonZeroU16

Packet Identifier

PublishComplete

Publish complete (assured delivery part 3)

Fields of PublishComplete

packet_id: NonZeroU16

Packet Identifier

Subscribe

Client subscribe request

Fields of Subscribe

packet_id: NonZeroU16

Packet Identifier

topic_filters: Vec<(ByteString, QoS)>

the list of Topic Filters and QoS to which the Client wants to subscribe.

SubscribeAck

Subscribe acknowledgment

Fields of SubscribeAck

packet_id: NonZeroU16status: Vec<SubscribeReturnCode>

corresponds to a Topic Filter in the SUBSCRIBE Packet being acknowledged.

Unsubscribe

Unsubscribe request

Fields of Unsubscribe

packet_id: NonZeroU16

Packet Identifier

topic_filters: Vec<ByteString>

the list of Topic Filters that the Client wishes to unsubscribe from.

UnsubscribeAck

Unsubscribe acknowledgment

Fields of UnsubscribeAck

packet_id: NonZeroU16

Packet Identifier

PingRequest

PING request

PingResponse

PING response

Disconnect

Client is disconnecting

Implementations

impl Packet

pub fn packet_type(&self) -> u8

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl From<Connect> for Packet

fn from(val: Connect) -> Packet

Performs the conversion.

impl From<Publish> for Packet

fn from(val: Publish) -> Packet

Performs the conversion.

impl PartialEq<Packet> for Packet

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<Io> Sink<Packet> for ConnectAck<Io> where
    Io: AsyncRead + AsyncWrite + Unpin, 

type Error = Either<EncodeError, Error>

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Packet) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<Io, St> Sink<Packet> for ConnectAckResult<Io, St> where
    Io: AsyncRead + AsyncWrite + Unpin, 

type Error = Either<EncodeError, Error>

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Packet) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl StructuralPartialEq for Packet