blob: df12934c3e28aedc43c077643ec872d3bed3c214 [file] [log] [blame] [view]
Jason Macnakefaa0952019-12-12 22:33:33 +00001bitflags
2========
3
4[![Build Status](https://travis-ci.com/bitflags/bitflags.svg?branch=master)](https://travis-ci.com/bitflags/bitflags)
5[![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)
8![Minimum rustc version](https://img.shields.io/badge/rustc-1.20+-yellow.svg)
9![License](https://img.shields.io/crates/l/bitflags.svg)
10
11A Rust macro to generate structures which behave like a set of bitflags
12
13- [Documentation](https://docs.rs/bitflags)
14- [Release notes](https://github.com/bitflags/bitflags/releases)
15
16## Usage
17
18Add this to your `Cargo.toml`:
19
20```toml
21[dependencies]
22bitflags = "1.0"
23```
24
25and this to your crate root:
26
27```rust
28#[macro_use]
29extern crate bitflags;
30```
31
32## Rust Version Support
33
34The minimum supported Rust version is 1.20 due to use of associated constants.