bitable 0.1.0

An all-const, compile-time checked, safe bit handling library with zero runtime overhead
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use super::common::*;
use super::set::Set;

/// A generic bit mask of type `T`
#[repr(transparent)]
#[derive(Debug)] //, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Mask {
    mask: UReg,
}

#[allow(private_bounds)]
impl const Mask
{
    pub fn apply<In, Out, const OFFSET: u8, const SIZE: u8>(&self, bitset: &In) -> UReg
    where In: const Set<Out, OFFSET, SIZE>,
          Out: const CastFromUReg,
    {
        let _ = <In>::ASSERT_MASK;
        bitset.read() & self.mask
    }

    pub fn apply_at<In, Out, const OFFSET: u8, const SIZE: u8>(&self, bitset: &In, idx: usize) -> UReg
    where In: const Set<Out, OFFSET, SIZE>,
          Out: const CastFromUReg,
    {
        let _ = <In>::ASSERT_MASK;
        bitset.read_at(idx) & self.mask
    }

    pub fn new(mask: UReg) -> Self {
        Self { mask }
    }
}

// ---------------------------------------------------------------------------
// Conversion between core types
// ---------------------------------------------------------------------------

impl const From<Mask> for UReg {
    fn from(bitmask: Mask) -> Self {
        bitmask.mask
    }
}