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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
//! # Bitbite
//! Bitbite is a simple trait that would help you interact bytes with flags easily
//!
//! # How to use
//! All you need to do is declare the flags and implement the trait.
//! ```rust
//! use bitbite::{Flag, Bitbite};
//! use std::ops::{Deref, DerefMut};
//!
//! struct NesCartridgeF6(pub u8);
//! impl NesCartridgeF6 {
//! pub const LOWER_MAPPER: Flag<u8> = Flag::<u8>::new(0b1111_0000);
//! }
//!
//!
//! impl Deref for NesCartridgeF6 {
//! type Target = u8;
//!
//! fn deref(&self) -> &Self::Target {
//! &self.0
//! }
//! }
//!
//! impl DerefMut for NesCartridgeF6 {
//! fn deref_mut(&mut self) -> &mut Self::Target {
//! &mut self.0
//! }
//! }
//!
//! impl Bitbite for NesCartridgeF6 {
//! type Unit = u8;
//! }
//!
//! let mut t = NesCartridgeF6(0b0110_0000);
//! let lower_mapper = t.get_flag(&NesCartridgeF6::LOWER_MAPPER);
//! assert_eq!(lower_mapper, 0b0110);
//! ```
//!
//! Getting the flag value will always be shifted so you won't need to shift the data yourself
//!
//! # Bigger flags
//! The trait `BitBite` and the struct `Flag` are generics and can hold any primitive integer, so you could have a struct that hold 1,2,4 bytes of data and still use the flags seamlessly.
//!
//! ## Mutability
//! You can now edit your bytes with flags with ease, you can use `set_flag` to override the entire flag's mask and change it as you please. \
//! And in case you don't want to override the previous values you can `set_on` different bits to hold their state as it is.
//! # Derive   ![Latest Version Derive]
//! For easier use you can add the [bitbite_derive](https://crates.io/crates/bitbite_derive) crate \
//! I also recommend using [defer-derive](https://crates.io/crates/deref_derive) for maximum ease
//! ```rust
//! use bitbite::*;
//! use bitbite_derive::Bitbite;
//! use deref_derive::*;
//!
//! #[derive(Bitbite, Deref, DerefMut)]
//! struct Header(pub u8);
//! ```
use PrimInt;
use DerefMut;
/// # Flag
/// **Flag** is used to declare flags \
/// To initialize the flag you need to pass in the flag's mask and units.
/// ```
/// use bitbite::Flag;
///
/// struct Header(u8);
///
/// impl Header {
/// pub const FIRST_NIBBLE : Flag<u8> = Flag::new(0b0000_1111);
/// pub const SECOND_NIBBLE_FIRST_HALF : Flag<u8> = Flag::new(0b0011_0000);
/// pub const SECOND_NIBBLE_SECOND_HALF : Flag<u8> = Flag::new(0b0011_0000);
/// }
/// ```
/// [Bitbite] Bitbite is a simple trait that would help you interact bytes with flags easily