bitman 2.0.1

An easy to use bit manipulation library for Rust
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Rips your variables to Bits!
//!
//! The *Bit* and *Bits* structures are the heart of *bitman*.
//!
#![allow(incomplete_features)]
#![feature(specialization)]
#![cfg_attr(not(test), no_std)]

use core::fmt::Debug;
use core::{
    mem::size_of,
    ops::{BitAnd, BitAndAssign, BitOr, BitOrAssign, Not},
};
extern crate alloc;
use alloc::borrow::ToOwned;
use alloc::vec;
use num_traits::{CheckedShl, One, Zero};

mod bit;
pub use bit::*;

mod bits;
pub use bits::*;

#[cfg(test)]
mod bitman_tests;
#[cfg(test)]
pub use bitman_tests::*;

trait BitMan
where
    Self: Sized
        + BitAnd<Output = Self>
        + BitAndAssign
        + BitOr
        + BitOrAssign
        + Not<Output = Self>
        + Debug
        + PartialEq
        + ToOwned<Owned = Self>
        + CheckedShl
        + Zero
        + One,
{
    #[inline]
    fn bit_len(&self) -> usize {
        size_of::<Self>() * 8
    }

    #[inline]
    fn bit(&self, index: &u32) -> Bit {
        let mut mask = Self::one();
        let offset: u32 = (self.bit_len() as u32 - 1) - *index;
        if let Some(new_mask) = CheckedShl::checked_shl(&mask, offset) {
            mask = new_mask;
        } else {
            panic!(
                "Index {:?} passed to bit() is beyond the bounds of {:?}",
                index, self
            );
        }
        mask = self.to_owned() & mask;
        Bit(mask != Self::zero())
    }

    #[inline]
    fn set_bit(&mut self, index: &u32, bit: &Bit) {
        assert!(*index <= ((self.bit_len()) - 1).try_into().unwrap(), "Index out of range in call to set_bit()");
        if **bit {
            let mut mask: Self = Self::one();
            if let Some(new_mask) = mask.checked_shl((self.bit_len() as u32 - 1) - index) {
                mask = new_mask;
                *self |= mask;
            }
        } else {
            let mut mask: Self = Self::one();
            if let Some(new_mask) = mask.checked_shl((self.bit_len() as u32 - 1) - index) {
                mask = !new_mask;
                *self &= mask;
            }
        }
    }

    #[inline]
    fn bits(&self) -> Bits {
        let mut output_value: Bits = Bits::new(&vec![Bit(false); self.bit_len()]);
        for current_index in 0..self.bit_len() as u32 {
            (*output_value)[current_index as usize] = self.bit(&current_index);
        }
        output_value
    }

    #[inline]
    fn set_bits(&mut self, mut index: u32, bits: &Bits) {
        for current_bit in bits.iter() {
            if current_bit.0 {
                let mut mask: Self = Self::one();
                if let Some(new_mask) =
                    CheckedShl::checked_shl(&mask, self.bit_len() as u32 - index)
                {
                    mask = new_mask;
                } else {
                    mask = Self::zero();
                }
                *self &= !mask;
            } else {
                let mut mask: Self = Self::one();
                if let Some(new_mask) =
                    CheckedShl::checked_shl(&mask, self.bit_len() as u32 - index)
                {
                    mask = new_mask;
                } else {
                    mask = Self::zero();
                }
                *self |= mask;
            }
            index += 1;
        }
    }
}

impl BitMan for u8 {}

impl BitMan for u16 {}

impl BitMan for u32 {}

impl BitMan for u64 {}

impl BitMan for u128 {}

impl BitMan for usize {}

impl BitMan for i8 {}

impl BitMan for i16 {}

impl BitMan for i32 {}

impl BitMan for i64 {}

impl BitMan for i128 {}

impl BitMan for isize {}