bitorder 0.0.2

Library to read and write bits in lsb or msb order.
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use core::cmp::{Eq, PartialEq};
use core::ops::{BitAnd, BitAndAssign, BitOr, BitOrAssign, Not, Shl, Shr};

// Not all traits integer types satisfy, but enough for what I'm doing
pub trait Uint
where
    Self: Sized
        + BitAnd<Output = Self>
        + BitAndAssign
        + BitOr<Output = Self>
        + BitOrAssign
        + Not<Output = Self>
        + Shl<usize, Output = Self>
        + Shr<usize, Output = Self>
        + From<u8>
        + TryInto<u8>
        + PartialEq
        + Eq
        + Copy,
{
    const WIDTH: usize;
    const ONE: Self;
    const ZERO: Self;

    /// Returns the bits from [start, stop) shifted so that start becomes 0
    fn get_bit_slice(self, start: usize, stop: usize) -> Self {
        let len = stop - start;
        let bitmask = ((!Self::ZERO) >> (Self::WIDTH - len)) << start;
        (self & bitmask) >> start
    }

    /// Copies the bits [start, stop) from val to self and returns the result
    fn set_bit_slice(self, start: usize, stop: usize, val: Self) -> Self {
        let len = stop - start;
        let bitmask = ((!Self::ZERO) >> (Self::WIDTH - len)) << start;
        (self & !bitmask) | ((val << start) & bitmask)
    }

    // Shl that clamps to 0 if rhs is out of range
    fn saturating_shl(self, rhs: usize) -> Self;

    // Shr that clamps to 0 if rhs is out of range
    fn saturating_shr(self, rhs: usize) -> Self;

    fn as_u8(self) -> u8;
}

macro_rules! impl_uint_trait {
    ($num_type:ident) => {
        impl Uint for $num_type {
            const WIDTH: usize = $num_type::BITS as usize;
            const ZERO: $num_type = 0;
            const ONE: $num_type = 1;

            #[inline(always)]
            fn saturating_shl(self, rhs: usize) -> Self {
                self.checked_shl(rhs as u32).unwrap_or(0)
            }

            #[inline(always)]
            fn saturating_shr(self, rhs: usize) -> Self {
                self.checked_shr(rhs as u32).unwrap_or(0)
            }

            #[inline(always)]
            fn as_u8(self) -> u8 {
                (self & 0xff) as u8
            }
        }
    };
}

impl_uint_trait!(u8);
impl_uint_trait!(u16);
impl_uint_trait!(u32);
impl_uint_trait!(u64);
impl_uint_trait!(u128);