denyhosts/clamav/libclamav_rust/.cargo/vendor/bit_field/README.md

32 lines
641 B
Markdown
Raw Normal View History

2023-01-14 18:28:39 +08:00
# 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.9.0"
```
## 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.