Comments (4)
Not really documentation per se, but I've finally opensourced https://github.com/vincentdephily/mqttest, which could be mentioned as a code example. I won't make a PR just for a readme, but I might manage to finish the MVP client example in the next few weeks, and send a PR with both.
from mqttrs.
I think a format that works well for Rust is writing a tutorial
module, so the docs are tested by the toolchain, sit along the "reference" doc, can be viewed both locally and on docs.rs, and aren't tied to github.
That said, I'm not sure there's a big need for separate doc pages ? There's certainly scope for improving the module-level docs, the inline docs and examples (I've got some WIP for utils.rs
), but mqttrs
has a very straightforward API to begin with.
I've started writing an MVP sync client (no CLI option, just connects, subscribes, publishes one message, and exits) using std
and bytes
only, but it's currently buggy. I think we should provide that and an async example using tokio (should we use the latest version with async/await ?) or libstd-async. I'll also link to my server as soon as it's FOSS, as a full-size tokio example (currently using tokio and old-style futures, but might eventually switch to async/await).
I'll try to finish that MVP client example, and get the server released.
from mqttrs.
Yes that is what i was thinking. one of the issues i have faced using libs is, i didn't know how to integrate this with other popular frameworks. so, if we can provide something like that, it makes very easy for lib users to just read the example and get on with the job instead of reading the whole docs or code.
from mqttrs.
@vincentdephily nice work.
from mqttrs.
Related Issues (20)
- `Connect.password` should be `Option<Vec<u8>>` instead of `Option<String>`.
- Refactor using a combined `QosPid` struct. HOT 1
- PacketIdentifier should be NonZeroU16
- Support MQTT5 HOT 8
- Add builder APIs
- Zero-copy encoding and decoding HOT 4
- Usage in no_std environments HOT 9
- New release on crates.io? HOT 2
- Support alloc-free operation HOT 3
- Serde feature enabled by default (through `std` feature) HOT 2
- Add `mqttrs::decode::check()` method, to see if the packet is decodable? HOT 2
- Proper way to extract packet length? HOT 2
- make every packet clonable.
- Example in README file does not work, cannot find encode/decode in this scope HOT 2
- Purging 0.4.0 in favour of simplicity and little bit of performance cost. HOT 10
- Fresh crates.io release HOT 2
- Unable to implement tokio_util::codec::{Decoder, Encoder} with mqttrs version 0.4 HOT 4
- Trouble Implementing Tokio-util Decoder for MQTT Broker
- Add integration examples with other libraries and runtimes.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mqttrs.