cobs

Changed

• Bumped MSRV to Rust 1.87 to allow heapless update, #63
• More efficient decoding implementation:
  #67 and #68.

Changed

• Bumped MSRV to Rust 1.87 to allow heapless update, #63
• More efficient decoding implementation: #67 and #68.

• Introduce MSRV, which is Rust 1.86
• Move to Rust edition 2024

Added

• New API to encoded data including the sentinel bytes:
  • encode_including_sentinels
  • try_encode_including_sentinels
  • encode_vec_including_sentinels
• CobsDecoderOwned which owns the decoding buffer and does not require lifetimes.
• CobsDecoderHeapless which owns the heapless decoding buffer and does not require lifetimes.

• Introduce MSRV, which is Rust 1.86
• Move to Rust edition 2024

Added

• New API to encoded data including the sentinel bytes:
  • encode_including_sentinels
  • try_encode_including_sentinels
  • encode_vec_including_sentinels
• CobsDecoderOwned which owns the decoding buffer and does not require lifetimes.
• CobsDecoderHeapless which owns the heapless decoding buffer and does not require lifetimes.

Fixed

• The encoder functions will now encode empty input into a single 0x01 byte.
  #49

Changed

• Bumped defmt dependency to v1
  #51
• decode now returns the DecodeReport structure which contains both the frame size
  and the parsed size.
  #50
• CobsDecoder::push also returns a DecodeReport now.
  #50
• The DecodeReport structure now has frame_size and parsed_size getter methods instead
  of public src_used / dst_used fields.
  #50
• The CobsDecoder is now able to continuously parse data without having to re-create
  it after each parsed packet.
  #50

Fixed

• The encoder functions will now encode empty input into a single 0x01 byte. #49

Changed

• Bumped defmt dependency to v1 #51
• decode now returns the DecodeReport structure which contains both the frame size and the parsed size. #50
• CobsDecoder::push also returns a DecodeReport now. #50
• The DecodeReport structure now has frame_size and parsed_size getter methods instead of public src_used / dst_used fields. #50
• The CobsDecoder is now able to continuously parse data without having to re-create it after each parsed packet. #50

This release (the first in a very long time) has been led by @robamu - huge thanks to him for making this happen!

What's Changed

• all easy clippy fixes and cargo fmt by @robamu in #21
• Make overhead and encoding len functions const by @robamu in #20
• Possible encoder bugfix by @robamu in #22
• add changelog by @robamu in #28
• Better error handling by @robamu in #30
• Add GitHub CI by @robamu in #31
• changelog update by @robamu in #33
• improve documentation, clarify behaviour regarding sentinel value by @robamu in #29
• bump rust edition to 2021 by @robamu in #34
• actually forgot the bump.. by @robamu in #35
• avoid panic on decode calls by @robamu in #36
• basic tests for encoder errors by @robamu in #37
• alloc feature that is still no_std by @jscatena88 in #24
• new alloc and std feature by @robamu in #38
• chore: update quickcheck dependency by @kaffarell in #25
• DecodeError tweak and consisten decode error behaviour by @robamu in #39
• add optional defmt support by @robamu in #40
• remove travis CI by @robamu in #42
• add optional serde support by @robamu in #41
• various improvements for documentation by @robamu in #43
• basic decoder error check by @robamu in #44
• prepare v0.3.0 by @robamu in #45

New Contributors

• @robamu made their first contribution in #21
• @jscatena88 made their first contribution in #24
• @kaffarell made their first contribution in #25

Full Changelog: v0.2.3...v0.3.0

Added

• Added max_encoding_overhead const function. #20
• Unittests for decode_in_place and decode_in_place_report. #36
• New alloc feature which enables support for APIs returning Vecs. #24
• New std feature, deprecate the use_std feature but keep it for backwards compatiblity. #38
• Documentation of the new std and alloc features in the README. #38
• Optional defmt support feature-gated by the optional defmt feature. #40
• Add optional serde support that adds serde derives for some errors and data structures. #41

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. #30
• max_encoding_length is now a const function. #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. #36
• Consistent behaviour of decode functions for empty input: All funtions now return DecodeError::FrameEmpty. #39

Fixed

• Fixed wrong encoded length when source length was divisible by 254. #19