packing 0.2.0

Bit packing and unpacking for arbitrarily aligned fields
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

use crate::{
    Unsigned, U0, U1, U2, U3, U4, U5, U6, U7, U8,
    IsLess,
};

/// Trait signifying a single bit in a byte. 7 = most significant bit, 0 = least significant bit
pub trait Bit: IsLess<U8> + Unsigned {
    /// The mask used to discard bits before this bit (i.e. if this bit is 5, ANDing this mask with 
    /// a u8 will ensure bits 7 and 6 are 0.
    const HEAD_MASK: u8 = ((1_u16 << (Self::USIZE + 1)) - 1) as u8;
    /// The mask used to extract the single bit from a byte
    const BIT_MASK: u8 = 1 << Self::USIZE;
    /// The mask used to discard bits after this bit (i.e. if this bit is 5, ANDing this mask with
    /// a u8 will ensure bits 4 to 0 are 0
    const TAIL_MASK: u8 = !((1_u16 << Self::USIZE) - 1) as u8;
}

impl Bit for U0 { }
impl Bit for U1 { }
impl Bit for U2 { }
impl Bit for U3 { }
impl Bit for U4 { }
impl Bit for U5 { }
impl Bit for U6 { }
impl Bit for U7 { }