Skip to content

Commit dffa2e3

Browse files
committed
document Cargo features
1 parent e197bf5 commit dffa2e3

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ Add `bitflags` to your `Cargo.toml`:
2020
version = "2.9.0"
2121
```
2222
23+
## Crate features
24+
25+
The `bitflags` library defines a few Cargo features that you can opt-in to:
26+
27+
- `std`: Implement the `Error` trait on error types used by `bitflags`.
28+
- `serde`: Support deriving `serde` traits on generated flags types.
29+
- `arbitrary`: Support deriving `arbitrary` traits on generated flags types.
30+
- `bytemuck`: Support deriving `bytemuck` traits on generated flags types.
31+
2332
## Generating flags types
2433
2534
Use the [`bitflags`] macro to generate flags types:

0 commit comments

Comments
 (0)