1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
//! Generate bit-flags struct and methods.
//!
//! It's very simple and easy to use. See the example below for details.
//!
//! # Usage
//!
//! Import this crate and `paste` to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! tiny-bit-flags = "0.1"
//! paste = "1.0"
//! ```
//!
//! Invoke the `tiny_bit_flags!` macro to define flags:
//!
//! ```rust
//! tiny_bit_flags::tiny_bit_flags! {
//! struct PrimFlags: u32 { // FORMAT: struct <StructName>: <InnerType>
//! // list flags below
//! const WRITABLE = 0b00000001;
//! const EXECUTABLE = 0b00000010;
//! }
//! }
//! ```
//!
//! This actually generates the following code:
//!
//! ```rust,ignore
//! // struct
//! struct PrimFlags(u32);
//!
//! impl PrimFlags {
//! // constant values
//! const WRITABLE: u32 = 0b00000001;
//! const EXECUTABLE: u32 = 0b00000010;
//! // checking methods
//! const fn is_writable(&self) -> bool { ... }
//! const fn is_executable(&self) -> bool { ... }
//! // setting methods
//! const fn set_writable(&mut self) { ... }
//! const fn set_executable(&mut self) { ... }
//! // clearing methods
//! const fn clear_writable(&mut self) { ... }
//! const fn clear_executable(&mut self) { ... }
//! }
//! ```
//!
//! Then you can use them in your program:
//!
//! ```rust,ignore
//! let mut f = PrimFlags(PrimFlags::WRITABLE); // initialize
//! assert!(f.is_writable()); // check flag
//! assert!(!f.is_executable());
//!
//! f.clear_writable(); // clear flag
//! assert!(!f.is_writable());
//!
//! f.set_executable(); // set flag
//! assert!(f.is_executable());
//! ```
//!
//! You can use `pub` before `struct` to make all above to be public:
//!
//! ```diff
//! tiny_bit_flags! {
//! + pub struct PrimFlags: u32 {
//! - struct PrimFlags: u32 {
//! ```
//!
//! You can also derive some traits on the struct:
//!
//! ```diff
//! tiny_bit_flags! {
//! + #[derive(Copy, Clone, Debug, Default)]
//! struct PrimFlags: u32 {
//! ```
/// Generate bit-flags struct and methods.
///
/// See module-level document for details.
///
/// Example:
///
/// ```rust
/// tiny_bit_flags::tiny_bit_flags! {
/// struct PrimFlags: u32 {
/// const WRITABLE = 0b00000001;
/// const EXECUTABLE = 0b00000010;
/// }
/// }
///
/// let mut f = PrimFlags(PrimFlags::WRITABLE); // initialize
/// assert!(f.is_writable()); // check flag
/// assert!(!f.is_executable());
///
/// f.clear_writable(); // clear flag
/// assert!(!f.is_writable());
///
/// f.set_executable(); // set flag
/// assert!(f.is_executable());
/// ```
///
) =>
)*
}
};
}