xbits

Crates.ioxbits
lib.rsxbits
version0.9.0
created_at2025-07-04 11:21:41.491116+00
updated_at2025-08-05 08:52:27.657306+00
descriptionBits operations on [u8]
homepagehttps://artimonist.org/
repositoryhttps://github.com/artimonist/xbits/
max_upload_size
id1737829
size51,692
Artimonist (artimonist)

documentation

README

Bit operations on [u8]

Usage

[u16] chunks to mnemonic indices by 11 bits.
[u8] chunks to base64 indices by 6 bits.

Examples

use xbits::XBits;
use xbits::FromBits;

assert_eq!(vec![0b1111_1111, 0b1100_0000].as_bits().all_one(), false);
assert_eq!(vec![0b1111_1111, 0b1100_0000].as_bits().trailing_zeros(), 6);

assert_eq!(
    [0b1111_0000_u8].as_bits().iter().collect::<Vec<bool>>(),
    vec![true, true, true, true, false, false, false, false]
);

assert_eq!(
    vec![0b1111_1111, 0b1111_1111].as_bits().chunks(6).collect::<Vec<u8>>(),
    vec![0b11_1111, 0b11_1111, 0b11_1100]
);

assert_eq!(
    vec![0b1111_1111; 3].as_bits().chunks(11).collect::<Vec<u16>>(),
    vec![0b111_1111_1111, 0b111_1111_1111, 0b110_0000_0000]
);

assert_eq!(
  vec![0b1111_1111, 0b1100_0000].as_bits_mut().reverse().to_ref().as_bytes(),
  vec![0b0000_0011, 0b1111_1111]
);

// FromBits
assert_eq!(
    Vec::from_bits([true, true, true, true, false, false, false, false].iter().copied()),
    [0b1111_0000]
);
assert_eq!(
    Vec::from_bit_chunks([0b11_1111_u8, 0b11_1111, 0b11_1111].into_iter(), 6),
    vec![0b1111_1111, 0b1111_1111, 0b1100_0000]
);
assert_eq!(
    Vec::from_bit_chunks([0b1111_u16, 0b1111, 0b1111].into_iter(), 6),
    vec![0b001111_00, 0b1111_0011, 0b1100_0000]
);
Commit count: 0

cargo fmt