blob: 0da0f853661b002e2a046fece8a017b01c7966a4 [file] [log] [blame] [view]
Jason Macnakefaa0952019-12-12 22:33:33 +00001bitflags
2========
3
Joel Galensonf9c300d2021-09-22 14:30:25 -07004[![Rust](https://github.com/bitflags/bitflags/workflows/Rust/badge.svg)](https://github.com/bitflags/bitflags/actions)
Jason Macnakefaa0952019-12-12 22:33:33 +00005[![Join the chat at https://gitter.im/bitflags/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bitflags/Lobby?utm_source=badge&utm_medium=badge&utm_content=badge)
6[![Latest version](https://img.shields.io/crates/v/bitflags.svg)](https://crates.io/crates/bitflags)
7[![Documentation](https://docs.rs/bitflags/badge.svg)](https://docs.rs/bitflags)
Jason Macnakefaa0952019-12-12 22:33:33 +00008![License](https://img.shields.io/crates/l/bitflags.svg)
9
10A Rust macro to generate structures which behave like a set of bitflags
11
12- [Documentation](https://docs.rs/bitflags)
13- [Release notes](https://github.com/bitflags/bitflags/releases)
14
15## Usage
16
17Add this to your `Cargo.toml`:
18
19```toml
20[dependencies]
Joel Galensonf9c300d2021-09-22 14:30:25 -070021bitflags = "1.3"
Jason Macnakefaa0952019-12-12 22:33:33 +000022```
23
Joel Galensonf9c300d2021-09-22 14:30:25 -070024and this to your source code:
Jason Macnakefaa0952019-12-12 22:33:33 +000025
26```rust
Joel Galensonf9c300d2021-09-22 14:30:25 -070027use bitflags::bitflags;
Jason Macnakefaa0952019-12-12 22:33:33 +000028```
29
30## Rust Version Support
31
Joel Galensonf9c300d2021-09-22 14:30:25 -070032The minimum supported Rust version is 1.46 due to use of associated constants and const functions.