mqtt_packet_3_5
| Crates.io | mqtt_packet_3_5 |
| lib.rs | mqtt_packet_3_5 |
| version | 0.2.2 |
| source | src |
| created_at | 2022-01-28 22:50:30.194121 |
| updated_at | 2022-02-03 22:09:11.125172 |
| description | Parse/Encode MQTT5 and MQTT3 messages |
| homepage | |
| repository | https://github.com/SquattingSocrates/mqtt_packet |
| max_upload_size | |
| id | 523326 |
| size | 206,657 |
Yuriy Voshchepynets (SquattingSocrates)
documentation
README
Mqtt message decoding/encoding library
This is a library designed to be used for creating mqtt clients or mqtt brokers. As many things as were reasonable are encoded in the type system, e.g.
- packets have their own types, except for PUBCOMP/PUBREC/PUBREL/PUBACK, since they are essentially the same
- reason codes are enums and it's not possible to build a packet with an invalid reason code
- properties are defined for every single packet type and therefore only valid property codes can be written into the packet
Supports: MQTTv3 and MQTTv5
Messages of these versions should be decodable/encodable with this library.
What works so far (Implemented and tested):
| Encode | Decode | Packet Type |
|---|---|---|
| ✅ | ✅ | Connect |
| ✅ | ✅ | Connack |
| ✅ | ✅ | Publish |
| ✅ | ✅ | Puback |
| ✅ | ✅ | Pubrec |
| ✅ | ✅ | Pubrel |
| ✅ | ✅ | Pubcomp |
| ✅ | ✅ | Subscribe |
| ✅ | ✅ | Suback |
| ✅ | ✅ | Unsubscribe |
| ✅ | ✅ | Unsuback |
| ✅ | ✅ | Pingreq |
| ✅ | ✅ | Pingresp |
| ✅ | ✅ | Disconnect |
| ✅ | ✅ | Auth |
However certain things still need to be added/improved:
- A better command building API?
- Make only necessary code public
- Support for Maximum Packet Size (MQTTv5). Should not send certain properties if they "bloat" the packet
- Ensure all properties have the correct Optionality set in their types
- Add some fuzzing tests to prevent unwanted panic! calls
- Improve documentation