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