diff options
Diffstat (limited to 'vendor/bit_field/README.md')
-rw-r--r-- | vendor/bit_field/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/vendor/bit_field/README.md b/vendor/bit_field/README.md new file mode 100644 index 0000000..ef47b9e --- /dev/null +++ b/vendor/bit_field/README.md @@ -0,0 +1,31 @@ +# 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. |