32 lines
642 B
Markdown
32 lines
642 B
Markdown
|
# bit_field
|
||
|
|
|
||
|
|
A simple crate which provides the `BitField` trait, which provides methods for operating on individual bits and ranges
|
||
|
|
of bits on Rust's integral types.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
Documentation is available on [docs.rs](https://docs.rs/bit_field)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
```TOML
|
||
|
|
[dependencies]
|
||
|
|
bit_field = "0.10.1"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Example
|
||
|
|
```rust
|
||
|
|
extern crate bit_field;
|
||
|
|
use bit_field::BitField;
|
||
|
|
|
||
|
|
let mut x: u8 = 0;
|
||
|
|
|
||
|
|
x.set_bit(7, true);
|
||
|
|
assert_eq!(x, 0b1000_0000);
|
||
|
|
|
||
|
|
x.set_bits(0..4, 0b1001);
|
||
|
|
assert_eq!(x, 0b1000_1001);
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
This crate is dual-licensed under MIT or the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details.
|