static-bytes 0.3.0

Bytes for embedded devices
Documentation
  • Coverage
  • 100%
    4 out of 4 items documented2 out of 3 items with examples
  • Size
  • Source code size: 31.48 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 856.44 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Links
  • xoac/static-bytes
    7 1 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • xoac

crates.io Documentation CI master Maintenance

static-bytes

The aim of this crate is to improve user experience when working with static bytes. Look at this pseudo code example to understand problem with &mut [u8] and bytes::buf::BufMut

let mut fixed_storage = [u8; 16];
let mut slice = fixed_storage[..];
let len_before = slice.len();
// declaration fn encode(&self, buf: &mut dyn BufMut);
frame.encode(&mut slice);
let len = len_before - slice.len();
let filled_bytes = fixed_storage[..len];

There are two problems with code above:

  • it will panic if encode want to use more than 16 bytes!
  • it is boilerplate

You can resolve both with SafeBytesSlice. For example usage see docs.

Compatibility with bytes

  • v0.1.x is compatible with bytes >=0.5.0, <0.6.0
  • v0.2.x is compatible with bytes >=0.6.0, <0.7.0
  • v0.3.x is compatible with bytes >=0.1.0, <2.0.0

License

Licensed under either of

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.

This project try follow rules:

This README was generated with cargo-readme from template