Skip to content

Commit

Permalink
Add a capabilities example to the README.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
tiaanl committed Jan 23, 2022
1 parent 7a9d7c7 commit 6df2ce2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Expand Up @@ -27,6 +27,30 @@ and this to your source code:
use bitflags::bitflags;
```

## Example

Generate a flags structure:

```rust
use bitflags::bitflags;

bitflags! {
struct Flags: u32 {
const A = 0b00000001;
const B = 0b00000010;
const C = 0b00000100;
const ABC = Self::A.bits | Self::B.bits | Self::C.bits;
}
}

fn main() {
let mut flags = Flags::A | Flags::B;
assert!(flags.contains(Flags::A));
flags.set(Flags::C, true);
assert!(flags.contains(Flags::A | Flags::C));
}
```

## Rust Version Support

The minimum supported Rust version is 1.46 due to use of associated constants and const functions.

0 comments on commit 6df2ce2

Please sign in to comment.