Struct FixedBitCount

pub struct FixedBitCount<const BITS: u32>;

A fixed number of bits to be consumed or written

Analagous to BitCount, this is a zero-sized type whose value is fixed at compile-time and cannot be changed.

Example

use bitstream_io::{
    BigEndian, BitRead, BitReader, BitWrite, BitWriter, CheckedUnsignedFixed, FixedBitCount,
};

type FourBits = CheckedUnsignedFixed<4, u8>;

let input: &[u8] = &[0b0001_1111, 0b0110_1001];
let mut r = BitReader::endian(input, BigEndian);

// read 4, 4-bit values
let v1 = r.read_checked::<FourBits>(FixedBitCount).unwrap();
let v2 = r.read_checked::<FourBits>(FixedBitCount).unwrap();
let v3 = r.read_checked::<FourBits>(FixedBitCount).unwrap();
let v4 = r.read_checked::<FourBits>(FixedBitCount).unwrap();

assert_eq!(v1.into_value(), 0b0001);
assert_eq!(v2.into_value(), 0b1111);
assert_eq!(v3.into_value(), 0b0110);
assert_eq!(v4.into_value(), 0b1001);

// write those same values back to disk
let mut w = BitWriter::endian(vec![], BigEndian);
w.write_checked(v1).unwrap();
w.write_checked(v2).unwrap();
w.write_checked(v3).unwrap();
w.write_checked(v4).unwrap();

// ensure they're the same
assert_eq!(w.into_writer().as_slice(), input);

Trait Implementations

impl<const BITS: u32> Clone for FixedBitCount<BITS>

fn clone(&self) -> FixedBitCount<BITS>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const BITS: u32> Debug for FixedBitCount<BITS>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const BITS: u32> From<FixedBitCount<BITS>> for BitCount<BITS>

fn from(_count: FixedBitCount<BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: u32, const MAX: u32> TryFrom<BitCount<MAX>> for FixedBitCount<BITS>

type Error = BitCount<MAX>

The type returned in the event of a conversion error.

fn try_from(count: BitCount<MAX>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const BITS: u32> Copy for FixedBitCount<BITS>