Source code
Revision control
Copy as Markdown
Other Tools
Change Log
=======
All notable changes to this project will be documented in this file.
# [unreleased]
# [v0.3.0] 2025-01-31
## Added
- Added `max_encoding_overhead` const function.
- Unittests for `decode_in_place` and `decode_in_place_report`.
- New `alloc` feature which enables support for APIs returning `Vec`s.
- New `std` feature, deprecate the `use_std` feature but keep it for backwards compatiblity.
- Documentation of the new `std` and `alloc` features in the README.
- Optional `defmt` support feature-gated by the optional `defmt` feature.
- Add optional `serde` support that adds `serde` derives for some errors and data structures.
## Changed
- Bumped rust edition to 2021
- Improved error handling by replacing unit errors with a new `DecodeError` enumeration for
the decoding module and a `DestBufTooSmallError` for the encoding module.
- `max_encoding_length` is now a const function. [#20](https://github.com/jamesmunns/cobs.rs/pull/20)
- `decode_in_place` and `decode_in_place_report` now check the destination index and return
an appropriate `DecodeError` instead of panicking if an out-of-bounds access happens.
- Consistent behaviour of decode functions for empty input: All funtions now return
`DecodeError::FrameEmpty`.
## Fixed
- Fixed wrong encoded length when source length was divisible by 254.