bitflagset 0.0.4

Enum and positional typed bitsets with Set API
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

#![no_std]

extern crate self as bitflagset;

#[cfg(any(feature = "alloc", test))]
extern crate alloc;

mod atomic;
#[cfg(feature = "alloc")]
mod atomic_boxed;
mod atomic_slice;
mod bitset;
#[cfg(feature = "alloc")]
mod boxed;
mod enumset;
mod slice;
mod word_op;

pub use atomic::*;
#[cfg(feature = "alloc")]
pub use atomic_boxed::*;
pub use atomic_slice::*;
#[cfg(feature = "derive")]
pub use bitflagset_derive::{BitFlag, BitFlagSet};
pub use bitset::*;
#[cfg(feature = "alloc")]
pub use boxed::*;
pub use enumset::*;
pub use slice::*;

#[doc(hidden)]
pub mod __private {
    #[cfg(feature = "bitflags")]
    pub use bitflags;
    pub use radium;
    pub use ref_cast;

    #[cold]
    #[inline(never)]
    #[track_caller]
    pub fn panic_index_out_of_range(idx: usize, cap: usize) -> ! {
        panic!("index {idx} out of range for capacity {cap}");
    }

    /// Panic when `idx` is outside `0..cap`. In-range calls are one not-taken branch.
    #[inline(always)]
    pub fn check_bit_index(idx: usize, cap: usize) {
        if idx >= cap {
            panic_index_out_of_range(idx, cap);
        }
    }

    /// `&true` / `&false` for `Index<Output = bool>`.
    #[inline(always)]
    pub fn bit_ref(on: bool) -> &'static bool {
        if on { &true } else { &false }
    }
}