diff options
author | Valentin Popov <valentin@popov.link> | 2024-01-08 00:21:28 +0300 |
---|---|---|
committer | Valentin Popov <valentin@popov.link> | 2024-01-08 00:21:28 +0300 |
commit | 1b6a04ca5504955c571d1c97504fb45ea0befee4 (patch) | |
tree | 7579f518b23313e8a9748a88ab6173d5e030b227 /vendor/bit_field/README.md | |
parent | 5ecd8cf2cba827454317368b68571df0d13d7842 (diff) | |
download | fparkan-1b6a04ca5504955c571d1c97504fb45ea0befee4.tar.xz fparkan-1b6a04ca5504955c571d1c97504fb45ea0befee4.zip |
Initial vendor packages
Signed-off-by: Valentin Popov <valentin@popov.link>
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. |