Module packet

Source
Expand description

MIT License

Copyright (c) 2025 Takatoshi Kondo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Modules§

as_concrete
kind
prelude
v3_1_1
v5_0

Structs§

AssignedClientIdentifier
AuthenticationData
AuthenticationMethod
ContentType
CorrelationData
MaximumPacketSize
MaximumQos
MessageExpiryInterval
MqttBinary
MQTT Binary Data representation with pre-encoded byte buffer
MqttString
MQTT String representation with pre-encoded byte buffer
PayloadFormatIndicator
ReasonString
ReceiveMaximum
RequestProblemInformation
RequestResponseInformation
ResponseInformation
ResponseTopic
RetainAvailable
ServerKeepAlive
ServerReference
SessionExpiryInterval
SharedSubscriptionAvailable
SubEntry
MQTT Subscription Entry
SubOpts
MQTT Subscription Options
SubscriptionIdentifier
SubscriptionIdentifierAvailable
TopicAlias
TopicAliasMaximum
TopicAliasRecv
Topic alias manager for receiving MQTT packets
TopicAliasSend
Topic alias manager for sending MQTT packets
UserProperty
VariableByteInteger
MQTT Variable Byte Integer representation with pre-encoded byte buffer.
WildcardSubscriptionAvailable
WillDelayInterval

Enums§

DecodeResult
Result for streaming decode.
FixedHeader
MQTT Fixed Header first byte enumeration
GenericPacket
GenericStorePacket
PacketType
MQTT Control Packet Type enumeration
PayloadFormat
Payload Format Indicator values
Property
MQTT v5.0 Property enum
PropertyId
MQTT v5.0 Property Identifiers
Qos
MQTT Quality of Service levels
ResponsePacket
ResponsePacket denotes the type of the response matching a stored packet.
RetainHandling
Retain Handling Option for MQTT Subscriptions

Traits§

GenericPacketDisplay
GenericPacketTrait
IsPacketId
Packet ID types with associated buffer operations
PropertiesParse
Trait for parsing properties collection from byte data
PropertiesSize
Trait for calculating the total encoded size of properties collection
PropertiesToBuffers
Trait for converting properties collection to I/O buffers

Functions§

escape_binary_json_string
MIT License

Type Aliases§

Packet
Properties
Collection of MQTT properties
StorePacket