| 1 |
# bit_field |
| 2 |
|
| 3 |
A simple crate which provides the `BitField` trait, which provides methods for operating on individual bits and ranges |
| 4 |
of bits on Rust's integral types. |
| 5 |
|
| 6 |
## Documentation |
| 7 |
Documentation is available on [docs.rs](https://docs.rs/bit_field) |
| 8 |
|
| 9 |
## Usage |
| 10 |
```TOML |
| 11 |
[dependencies] |
| 12 |
bit_field = "0.10.1" |
| 13 |
``` |
| 14 |
|
| 15 |
## Example |
| 16 |
```rust |
| 17 |
extern crate bit_field; |
| 18 |
use bit_field::BitField; |
| 19 |
|
| 20 |
let mut x: u8 = 0; |
| 21 |
|
| 22 |
x.set_bit(7, true); |
| 23 |
assert_eq!(x, 0b1000_0000); |
| 24 |
|
| 25 |
x.set_bits(0..4, 0b1001); |
| 26 |
assert_eq!(x, 0b1000_1001); |
| 27 |
|
| 28 |
``` |
| 29 |
|
| 30 |
## License |
| 31 |
This crate is dual-licensed under MIT or the Apache License (Version 2.0). See LICENSE-APACHE and LICENSE-MIT for details. |