https://github.com/phip1611/bit_ops

Bitwise operations on primitive integer types, but no_std and const-compatible. Provides a collection of typical bit manipulation operations that are primarily required in low-level development. Unlike other crates that provide tooling to create sophisticated high-level types with bitfields, the focus of bit_ops is to work on raw integers.
https://github.com/phip1611/bit_ops

bitwise rust

Last synced: about 1 year ago
JSON representation

Bitwise operations on primitive integer types, but no_std and const-compatible. Provides a collection of typical bit manipulation operations that are primarily required in low-level development. Unlike other crates that provide tooling to create sophisticated high-level types with bitfields, the focus of bit_ops is to work on raw integers.

• Host: GitHub
• URL: https://github.com/phip1611/bit_ops
• Owner: phip1611
• License: mit
• Created: 2024-07-10T14:35:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T05:10:17.000Z (about 1 year ago)
• Last Synced: 2025-04-05T11:19:14.219Z (about 1 year ago)
• Topics: bitwise, rust
• Language: Rust
• Homepage:
• Size: 71.3 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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 .

# Example

```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

1.57.0 stable

## License

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