firefox-main/third_party/rust/cobs/README.md

Source code

Revision control

Copy as Markdown

Other Tools

# `cobs`
This is an implementation of the Consistent Overhead Byte Stuffing (COBS) algorithm in Rust.
COBS is an algorithm for transforming a message into an encoding where a specific value (the "sentinel" value) is not used. This value can then be used to mark frame boundaries in a serial communication channel.
See [the wikipedia article](https://www.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) for details.
## Features
`cobs` supports various runtime environments and is also suitable for `no_std` environments.
### Default features
- [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library
and also activates the `alloc` feature. Currently only adds `std::error::Error` support for the
library error types.
- [`alloc`](https://doc.rust-lang.org/alloc/): Enables features which operate on containers
Enabled by the `std` feature.
### Optional features
- [`defmt`](https://docs.rs/defmt/latest/defmt/): Adds `defmt::Format` derives on some data
structures and error types.
- [`serde`](https://serde.rs/): Adds `serde` derives on some data structures and error types.
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.