wow_world_base 0.3.0

Base definitions and functions for World of Warcraft game servers
Documentation
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
/// Auto generated from the original `wowm` in file [`wow_message_parser/wowm/world/queries/smsg_item_query_single_response.wowm:590`](https://github.com/gtker/wow_messages/tree/main/wow_message_parser/wowm/world/queries/smsg_item_query_single_response.wowm#L590):
/// ```text
/// flag BagFamily : u32 {
///     NONE = 0x00000000;
///     ARROWS = 0x00000001;
///     BULLETS = 0x00000002;
///     SOUL_SHARDS = 0x00000004;
///     LEATHERWORKING_SUPPLIES = 0x00000008;
///     INSCRIPTION_SUPPLIES = 0x00000010;
///     HERBS = 0x00000020;
///     ENCHANTING_SUPPLIES = 0x00000040;
///     ENGINEERING_SUPPLIES = 0x00000080;
///     KEYS = 0x00000100;
///     GEMS = 0x00000200;
///     MINING_SUPPLIES = 0x00000400;
///     SOULBOUND_EQUIPMENT = 0x00000800;
///     VANITY_PETS = 0x00001000;
///     CURRENCY_TOKENS = 0x00002000;
///     QUEST_ITEMS = 0x00004000;
/// }
/// ```
#[derive(Debug, PartialEq, Eq, Hash, Ord, PartialOrd, Copy, Clone, Default)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
pub struct BagFamily {
    inner: u32,
}

#[cfg(feature = "print-testcase")]
impl BagFamily {
    #[allow(clippy::missing_const_for_fn)]
    pub fn as_test_case_value(&self) -> String {
        let mut s = String::new();
        let mut first = true;
        if self.is_empty() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "NONE").unwrap();
            first = false;
        }
        if self.is_arrows() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "ARROWS").unwrap();
            first = false;
        }
        if self.is_bullets() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "BULLETS").unwrap();
            first = false;
        }
        if self.is_soul_shards() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "SOUL_SHARDS").unwrap();
            first = false;
        }
        if self.is_leatherworking_supplies() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "LEATHERWORKING_SUPPLIES").unwrap();
            first = false;
        }
        if self.is_inscription_supplies() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "INSCRIPTION_SUPPLIES").unwrap();
            first = false;
        }
        if self.is_herbs() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "HERBS").unwrap();
            first = false;
        }
        if self.is_enchanting_supplies() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "ENCHANTING_SUPPLIES").unwrap();
            first = false;
        }
        if self.is_engineering_supplies() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "ENGINEERING_SUPPLIES").unwrap();
            first = false;
        }
        if self.is_keys() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "KEYS").unwrap();
            first = false;
        }
        if self.is_gems() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "GEMS").unwrap();
            first = false;
        }
        if self.is_mining_supplies() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "MINING_SUPPLIES").unwrap();
            first = false;
        }
        if self.is_soulbound_equipment() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "SOULBOUND_EQUIPMENT").unwrap();
            first = false;
        }
        if self.is_vanity_pets() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "VANITY_PETS").unwrap();
            first = false;
        }
        if self.is_currency_tokens() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "CURRENCY_TOKENS").unwrap();
            first = false;
        }
        if self.is_quest_items() {
            use std::fmt::Write;
            if !first {
                write!(s, " | ").unwrap();
            }
            write!(s, "QUEST_ITEMS").unwrap();
            first = false;
        }
        s
    }

}

impl BagFamily {
    pub const fn new(inner: u32) -> Self {
        Self { inner }
    }

    pub const NONE: u32 = 0x00;
    pub const ARROWS: u32 = 0x01;
    pub const BULLETS: u32 = 0x02;
    pub const SOUL_SHARDS: u32 = 0x04;
    pub const LEATHERWORKING_SUPPLIES: u32 = 0x08;
    pub const INSCRIPTION_SUPPLIES: u32 = 0x10;
    pub const HERBS: u32 = 0x20;
    pub const ENCHANTING_SUPPLIES: u32 = 0x40;
    pub const ENGINEERING_SUPPLIES: u32 = 0x80;
    pub const KEYS: u32 = 0x100;
    pub const GEMS: u32 = 0x200;
    pub const MINING_SUPPLIES: u32 = 0x400;
    pub const SOULBOUND_EQUIPMENT: u32 = 0x800;
    pub const VANITY_PETS: u32 = 0x1000;
    pub const CURRENCY_TOKENS: u32 = 0x2000;
    pub const QUEST_ITEMS: u32 = 0x4000;

    pub const fn empty() -> Self {
        Self { inner: 0 }
    }

    pub const fn is_empty(&self) -> bool {
        self.inner == 0
    }

    pub const fn all() -> Self {
        Self {
            inner: Self::NONE
                | Self::ARROWS
                | Self::BULLETS
                | Self::SOUL_SHARDS
                | Self::LEATHERWORKING_SUPPLIES
                | Self::INSCRIPTION_SUPPLIES
                | Self::HERBS
                | Self::ENCHANTING_SUPPLIES
                | Self::ENGINEERING_SUPPLIES
                | Self::KEYS
                | Self::GEMS
                | Self::MINING_SUPPLIES
                | Self::SOULBOUND_EQUIPMENT
                | Self::VANITY_PETS
                | Self::CURRENCY_TOKENS
                | Self::QUEST_ITEMS
        }
    }

    pub const fn is_arrows(&self) -> bool {
        (self.inner & Self::ARROWS) != 0
    }

    pub const fn new_arrows() -> Self {
        Self { inner: Self::ARROWS }
    }

    pub fn set_arrows(&mut self) -> Self {
        self.inner |= Self::ARROWS;
        *self
    }

    pub fn clear_arrows(&mut self) -> Self {
        self.inner &= Self::ARROWS.reverse_bits();
        *self
    }

    pub const fn is_bullets(&self) -> bool {
        (self.inner & Self::BULLETS) != 0
    }

    pub const fn new_bullets() -> Self {
        Self { inner: Self::BULLETS }
    }

    pub fn set_bullets(&mut self) -> Self {
        self.inner |= Self::BULLETS;
        *self
    }

    pub fn clear_bullets(&mut self) -> Self {
        self.inner &= Self::BULLETS.reverse_bits();
        *self
    }

    pub const fn is_soul_shards(&self) -> bool {
        (self.inner & Self::SOUL_SHARDS) != 0
    }

    pub const fn new_soul_shards() -> Self {
        Self { inner: Self::SOUL_SHARDS }
    }

    pub fn set_soul_shards(&mut self) -> Self {
        self.inner |= Self::SOUL_SHARDS;
        *self
    }

    pub fn clear_soul_shards(&mut self) -> Self {
        self.inner &= Self::SOUL_SHARDS.reverse_bits();
        *self
    }

    pub const fn is_leatherworking_supplies(&self) -> bool {
        (self.inner & Self::LEATHERWORKING_SUPPLIES) != 0
    }

    pub const fn new_leatherworking_supplies() -> Self {
        Self { inner: Self::LEATHERWORKING_SUPPLIES }
    }

    pub fn set_leatherworking_supplies(&mut self) -> Self {
        self.inner |= Self::LEATHERWORKING_SUPPLIES;
        *self
    }

    pub fn clear_leatherworking_supplies(&mut self) -> Self {
        self.inner &= Self::LEATHERWORKING_SUPPLIES.reverse_bits();
        *self
    }

    pub const fn is_inscription_supplies(&self) -> bool {
        (self.inner & Self::INSCRIPTION_SUPPLIES) != 0
    }

    pub const fn new_inscription_supplies() -> Self {
        Self { inner: Self::INSCRIPTION_SUPPLIES }
    }

    pub fn set_inscription_supplies(&mut self) -> Self {
        self.inner |= Self::INSCRIPTION_SUPPLIES;
        *self
    }

    pub fn clear_inscription_supplies(&mut self) -> Self {
        self.inner &= Self::INSCRIPTION_SUPPLIES.reverse_bits();
        *self
    }

    pub const fn is_herbs(&self) -> bool {
        (self.inner & Self::HERBS) != 0
    }

    pub const fn new_herbs() -> Self {
        Self { inner: Self::HERBS }
    }

    pub fn set_herbs(&mut self) -> Self {
        self.inner |= Self::HERBS;
        *self
    }

    pub fn clear_herbs(&mut self) -> Self {
        self.inner &= Self::HERBS.reverse_bits();
        *self
    }

    pub const fn is_enchanting_supplies(&self) -> bool {
        (self.inner & Self::ENCHANTING_SUPPLIES) != 0
    }

    pub const fn new_enchanting_supplies() -> Self {
        Self { inner: Self::ENCHANTING_SUPPLIES }
    }

    pub fn set_enchanting_supplies(&mut self) -> Self {
        self.inner |= Self::ENCHANTING_SUPPLIES;
        *self
    }

    pub fn clear_enchanting_supplies(&mut self) -> Self {
        self.inner &= Self::ENCHANTING_SUPPLIES.reverse_bits();
        *self
    }

    pub const fn is_engineering_supplies(&self) -> bool {
        (self.inner & Self::ENGINEERING_SUPPLIES) != 0
    }

    pub const fn new_engineering_supplies() -> Self {
        Self { inner: Self::ENGINEERING_SUPPLIES }
    }

    pub fn set_engineering_supplies(&mut self) -> Self {
        self.inner |= Self::ENGINEERING_SUPPLIES;
        *self
    }

    pub fn clear_engineering_supplies(&mut self) -> Self {
        self.inner &= Self::ENGINEERING_SUPPLIES.reverse_bits();
        *self
    }

    pub const fn is_keys(&self) -> bool {
        (self.inner & Self::KEYS) != 0
    }

    pub const fn new_keys() -> Self {
        Self { inner: Self::KEYS }
    }

    pub fn set_keys(&mut self) -> Self {
        self.inner |= Self::KEYS;
        *self
    }

    pub fn clear_keys(&mut self) -> Self {
        self.inner &= Self::KEYS.reverse_bits();
        *self
    }

    pub const fn is_gems(&self) -> bool {
        (self.inner & Self::GEMS) != 0
    }

    pub const fn new_gems() -> Self {
        Self { inner: Self::GEMS }
    }

    pub fn set_gems(&mut self) -> Self {
        self.inner |= Self::GEMS;
        *self
    }

    pub fn clear_gems(&mut self) -> Self {
        self.inner &= Self::GEMS.reverse_bits();
        *self
    }

    pub const fn is_mining_supplies(&self) -> bool {
        (self.inner & Self::MINING_SUPPLIES) != 0
    }

    pub const fn new_mining_supplies() -> Self {
        Self { inner: Self::MINING_SUPPLIES }
    }

    pub fn set_mining_supplies(&mut self) -> Self {
        self.inner |= Self::MINING_SUPPLIES;
        *self
    }

    pub fn clear_mining_supplies(&mut self) -> Self {
        self.inner &= Self::MINING_SUPPLIES.reverse_bits();
        *self
    }

    pub const fn is_soulbound_equipment(&self) -> bool {
        (self.inner & Self::SOULBOUND_EQUIPMENT) != 0
    }

    pub const fn new_soulbound_equipment() -> Self {
        Self { inner: Self::SOULBOUND_EQUIPMENT }
    }

    pub fn set_soulbound_equipment(&mut self) -> Self {
        self.inner |= Self::SOULBOUND_EQUIPMENT;
        *self
    }

    pub fn clear_soulbound_equipment(&mut self) -> Self {
        self.inner &= Self::SOULBOUND_EQUIPMENT.reverse_bits();
        *self
    }

    pub const fn is_vanity_pets(&self) -> bool {
        (self.inner & Self::VANITY_PETS) != 0
    }

    pub const fn new_vanity_pets() -> Self {
        Self { inner: Self::VANITY_PETS }
    }

    pub fn set_vanity_pets(&mut self) -> Self {
        self.inner |= Self::VANITY_PETS;
        *self
    }

    pub fn clear_vanity_pets(&mut self) -> Self {
        self.inner &= Self::VANITY_PETS.reverse_bits();
        *self
    }

    pub const fn is_currency_tokens(&self) -> bool {
        (self.inner & Self::CURRENCY_TOKENS) != 0
    }

    pub const fn new_currency_tokens() -> Self {
        Self { inner: Self::CURRENCY_TOKENS }
    }

    pub fn set_currency_tokens(&mut self) -> Self {
        self.inner |= Self::CURRENCY_TOKENS;
        *self
    }

    pub fn clear_currency_tokens(&mut self) -> Self {
        self.inner &= Self::CURRENCY_TOKENS.reverse_bits();
        *self
    }

    pub const fn is_quest_items(&self) -> bool {
        (self.inner & Self::QUEST_ITEMS) != 0
    }

    pub const fn new_quest_items() -> Self {
        Self { inner: Self::QUEST_ITEMS }
    }

    pub fn set_quest_items(&mut self) -> Self {
        self.inner |= Self::QUEST_ITEMS;
        *self
    }

    pub fn clear_quest_items(&mut self) -> Self {
        self.inner &= Self::QUEST_ITEMS.reverse_bits();
        *self
    }

    pub const fn as_int(&self) -> u32 {
        self.inner
    }

}

impl std::fmt::UpperHex for BagFamily {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::UpperHex::fmt(&self.inner, f)
    }
}

impl std::fmt::LowerHex for BagFamily {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::LowerHex::fmt(&self.inner, f)
    }
}

impl std::fmt::Octal for BagFamily {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Octal::fmt(&self.inner, f)
    }
}

impl std::fmt::Binary for BagFamily {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Binary::fmt(&self.inner, f)
    }
}

impl std::ops::BitAnd for BagFamily {
    type Output = Self;
    fn bitand(self, rhs: Self) -> Self::Output {
        Self { inner: self.inner.bitand(rhs.inner), }
    }
}

impl std::ops::BitAndAssign for BagFamily {
    fn bitand_assign(&mut self, rhs: Self) {
        self.inner.bitand_assign(rhs.inner)
    }
}

impl std::ops::BitOr for BagFamily {
    type Output = Self;
    fn bitor(self, rhs: Self) -> Self::Output {
        Self { inner: self.inner.bitor(rhs.inner), }
    }
}

impl std::ops::BitOrAssign for BagFamily {
    fn bitor_assign(&mut self, rhs: Self) {
        self.inner.bitor_assign(rhs.inner)
    }
}

impl std::ops::BitXor for BagFamily {
    type Output = Self;
    fn bitxor(self, rhs: Self) -> Self::Output {
        Self { inner: self.inner.bitxor(rhs.inner), }
    }
}

impl std::ops::BitXorAssign for BagFamily {
    fn bitxor_assign(&mut self, rhs: Self) {
        self.inner.bitxor_assign(rhs.inner)
    }
}

impl From<u32> for BagFamily {
    fn from(value: u32) -> Self {
        Self::new(value)
    }
}

impl From<u8> for BagFamily {
    fn from(value: u8) -> Self {
        Self::new(value.into())
    }
}

impl From<u16> for BagFamily {
    fn from(value: u16) -> Self {
        Self::new(value.into())
    }
}

impl TryFrom<u64> for BagFamily {
    type Error = u64;
    fn try_from(value: u64) -> Result<Self, Self::Error> {
        let a = TryInto::<u32>::try_into(value).ok().ok_or(value)?;
        Ok(Self::new(a))
    }
}

impl TryFrom<i8> for BagFamily {
    type Error = i8;
    fn try_from(value: i8) -> Result<Self, Self::Error> {
        let v = u8::from_le_bytes(value.to_le_bytes());
        Ok(Self::new(v.into()))
    }
}

impl TryFrom<i16> for BagFamily {
    type Error = i16;
    fn try_from(value: i16) -> Result<Self, Self::Error> {
        let v = u16::from_le_bytes(value.to_le_bytes());
        Ok(Self::new(v.into()))
    }
}

impl From<i32> for BagFamily {
    fn from(value: i32) -> Self {
        Self::new(u32::from_le_bytes(value.to_le_bytes()))
    }
}

impl TryFrom<i64> for BagFamily {
    type Error = i64;
    fn try_from(value: i64) -> Result<Self, Self::Error> {
        let v = u64::from_le_bytes(value.to_le_bytes());
        let a = TryInto::<u32>::try_into(v).ok().ok_or(value)?;
        Ok(Self::new(a))
    }
}

impl TryFrom<usize> for BagFamily {
    type Error = usize;
    fn try_from(value: usize) -> Result<Self, Self::Error> {
        let a = TryInto::<u32>::try_into(value).ok().ok_or(value)?;
        Ok(Self::new(a))
    }
}