jamesmunns / postcard

A no_std + serde compatible message library for Rust
Apache License 2.0
943 stars 91 forks source link

improved documentation of the cobs decoding #97

Closed gutzchi closed 1 year ago

gutzchi commented 1 year ago

I believe that the modification of the input buffer by the cobs decoding functions is not expected as a user of the library, as it requires you to copy the input buffer every time you call it. In postcard, this does not happen with the non-cobs serde functions.

I consider that by noting this fact in the documentation, other users might be able to realise it earlier and spend less time debugging as it happened to me.

netlify[bot] commented 1 year ago

Deploy Preview for cute-starship-2d9c9b canceled.

Name Link
Latest commit 04212a466a279722622e08eac4bfc3303b56afe4
Latest deploy log https://app.netlify.com/sites/cute-starship-2d9c9b/deploys/641c6a4501dd300008865324
jamesmunns commented 1 year ago

This looks like a very reasonable addition, thanks!