bit_ops 0.2.1

Common bit-oriented operations on primitive integer types with a focus on `no_std` and `const` compatibility. Unlike other crates that provide tooling to create sophisticated high-level types with bitfields, the focus of `bit_ops` is on raw primitive integer types.
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

# bit_ops

Common bit-oriented operations on primitive integer types with a focus on
`no_std` and `const` compatibility. Unlike other crates that provide tooling to
create sophisticated high-level types with bitfields, the focus of `bit_ops` is
on raw primitive integer types.

# Documentation

See <https://docs.rs/bit_ops>.

# Example

<!-- copied from lib.rs -->
```rust
fn main() {
    // PREREQUISITES: Some Definitions

    /// See specification of the x86 IOAPIC redirection entry for more details.
    mod x86_ioapic {
        pub const VECTOR_BITS: u64 = 8;
        pub const VECTOR_SHIFT: u64 = 0;
        pub const DELIVERY_MODE_BITS: u64 = 3;
        pub const DELIVERY_MODE_SHIFT: u64 = 8;
        pub const DESTINATION_MODE_BITS: u64 = 1;
        pub const DESTINATION_MODE_SHIFT: u64 = 11;
        pub const PIN_POLARITY_BITS: u64 = 1;
        pub const PIN_POLARITY_SHIFT: u64 = 13;
        pub const TRIGGER_MODE_BITS: u64 = 1;
        pub const TRIGGER_MODE_SHIFT: u64 = 15;
        pub const MASKED_BITS: u64 = 1;
        pub const MASKED_SHIFT: u64 = 16;
        pub const DESTINATION_BITS: u64 = 8;
        pub const DESTINATION_SHIFT: u64 = 56;
    }

    use x86_ioapic::*;

    // ACTUAL LIBRARY USAGE BEGINS HERE

    let redirection_entry = bit_ops::bitops_u64::set_bits_exact_n(
        0,
        &[
            (7, VECTOR_BITS, VECTOR_SHIFT),
            (0b111 /* ExtInt */, DELIVERY_MODE_BITS, DELIVERY_MODE_SHIFT),
            (0 /* physical */, DESTINATION_MODE_BITS, DESTINATION_MODE_SHIFT),
            (1 /* low-active */, PIN_POLARITY_BITS, PIN_POLARITY_SHIFT),
            (1 /* level-triggered */, TRIGGER_MODE_BITS, TRIGGER_MODE_SHIFT),
            (1 /* masked */, MASKED_BITS, MASKED_SHIFT),
            (13 /* APIC ID */, DESTINATION_BITS, DESTINATION_SHIFT),
        ],
    );
    assert_eq!(redirection_entry, 0xd0000000001a707);
}
```

## MSRV

<!-- Keep in sync with lib.rs and Cargo.toml!  -->
1.85 stable

## License

MIT License. See [LICENSE](./LICENSE) file.