Type Alias CheckedUnsignedFixed

pub type CheckedUnsignedFixed<const BITS: u32, T> = Checked<FixedBitCount<BITS>, T>;

An unsigned type with a verified value for a fixed number of bits

Aliased Type

pub struct CheckedUnsignedFixed<const BITS: u32, T> { /* private fields */ }

Implementations

impl<const BITS: u32, U: UnsignedInteger> CheckedUnsignedFixed<BITS, U>

pub fn new_fixed(value: U) -> Result<Self, CheckedError>

Returns our checked value if it fits in the given number of const bits

Examples

use bitstream_io::{CheckedUnsignedFixed, CheckedError};

// a value of 7 fits into a maximum of 3 bits
assert!(CheckedUnsignedFixed::<3, u8>::new_fixed(0b111).is_ok());

// a value of 8 does not fit into a maximum of 3 bits
assert!(matches!(
    CheckedUnsignedFixed::<3, u8>::new_fixed(0b1000),
    Err(CheckedError::ExcessiveValue),
));

use bitstream_io::CheckedUnsignedFixed;

// a bit count of 9 is too large for u8

// because this is checked at compile-time,
// it does not compile at all
let c = CheckedUnsignedFixed::<9, u8>::new_fixed(1);

Trait Implementations

impl<const BITS: u32, U: UnsignedInteger> Checkable for CheckedUnsignedFixed<BITS, U>

fn write<W: BitWrite + ?Sized>(&self, writer: &mut W) -> Result<()>

Write our value to the given stream

fn written_bits(&self) -> u32

The number of written bits

impl<const BITS: u32, U: UnsignedInteger> CheckablePrimitive for CheckedUnsignedFixed<BITS, U>

type CountType = FixedBitCount<BITS>

Our bit count type for reading

fn read<R: BitRead + ?Sized>( reader: &mut R, count: FixedBitCount<BITS>, ) -> Result<Self>

Reads our value from the given stream