scale-bits

Crates.ioscale-bits
lib.rsscale-bits
version0.6.0
sourcesrc
created_at2022-09-14 12:32:04.615689
updated_at2024-04-29 09:52:46.34903
descriptionA SCALE compatible representation of a collection of bits
homepagehttps://www.parity.io/
repositoryhttps://github.com/paritytech/scale-bits
max_upload_size
id665745
size59,522
Parity Crate Owner (parity-crate-owner)

documentation

https://docs.rs/scale-bits

README

scale-bits ยท CI Status Latest Version on Crates.io Released API docs

This small utility crate provides two separate things:

  1. A Bits type that can be SCALE encoded and decoded, and is fully SCALE compatible with a BitVec<u8, Lsb0>. It's a deliberately simple type that is conceptually just a sequence of bools, and can be used as a replacement for BitVec when you don't need the additional complexity and functionality that it comes with. See the bits module for more.
  2. Utility methods to help encode and decode arbitrary bit sequences from their SCALE representation, or skip over the corresponding bytes entirely, with zero allocations. These bypass the need to first go via some BitVec with the right store/order type, and are WASM compatible (unlike BitVec's u64 store type). See the scale module for more.

These things play nicely together (ie you can encode and decode arbitrary bit sequences directly into the Bits type), but don't need to be used together.

Commit count: 41

cargo fmt