tf2-enum 0.13.0

Provides enumerated types for models related to the Team Fortress 2 item schema.
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

use crate::StockWeapon;
use serde::{Deserialize, Serialize};
use strum::{Display, EnumCount, EnumIter, EnumString};

/// Item slot.
#[derive(
    Debug,
    Clone,
    Copy,
    Eq,
    PartialEq,
    Ord,
    PartialOrd,
    Hash,
    Display,
    Deserialize,
    Serialize,
    EnumString,
    EnumIter,
    EnumCount,
)]
#[strum(serialize_all = "snake_case")]
#[serde(rename_all = "snake_case")]
#[allow(missing_docs)]
pub enum ItemSlot {
    Melee,
    Primary,
    Secondary,
    #[strum(serialize = "pda")]
    #[serde(rename = "pda")]
    PDA,
    #[strum(serialize = "pda2")]
    #[serde(rename = "pda2")]
    PDA2,
    Building,
    Misc,
    Taunt,
    Action,
    Utility,
    Quest,
}

impl ItemSlot {
    /// Gets the stock weapons available for this item slot.
    pub fn stock_weapons(&self) -> &'static [StockWeapon] {
        match self {
            ItemSlot::Primary => &[
                StockWeapon::Scattergun,
                StockWeapon::FlameThrower,
                StockWeapon::SyringeGun,
                StockWeapon::RocketLauncher,
                StockWeapon::GrenadeLauncher,
                StockWeapon::SniperRifle,
                StockWeapon::Minigun,
                StockWeapon::Revolver,
                // The Shotgun is both a primary and secondary weapon.
                StockWeapon::Shotgun,
            ],
            ItemSlot::Secondary => &[
                StockWeapon::SMG,
                StockWeapon::StickybombLauncher,
                StockWeapon::Pistol,
                StockWeapon::MediGun,
                StockWeapon::Shotgun,
            ],
            ItemSlot::Melee => &[
                StockWeapon::Bat,
                StockWeapon::Bottle,
                StockWeapon::FireAxe,
                StockWeapon::Kukri,
                StockWeapon::Knife,
                StockWeapon::Fists,
                StockWeapon::Shovel,
                StockWeapon::Wrench,
                StockWeapon::Bonesaw,
                StockWeapon::Bottle,
            ],
            ItemSlot::PDA => &[
                StockWeapon::DisguiseKit,
                StockWeapon::ConstructionPDA,
            ],
            ItemSlot::PDA2 => &[
                StockWeapon::InvisWatch,
                StockWeapon::DestructionPDA,
            ],
            ItemSlot::Building => &[
                StockWeapon::PDA,
            ],
            // No stock weapons for these slots
            _ => &[],
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_item_slot_stock_weapons() {
        let primary_weapons = ItemSlot::Primary.stock_weapons();
        assert!(primary_weapons.contains(&StockWeapon::Scattergun));
        assert!(primary_weapons.contains(&StockWeapon::RocketLauncher));
    }
    
    #[test]
    fn serializes() {
        let json = serde_json::to_string(&ItemSlot::Primary).unwrap();
        assert_eq!(json, "\"primary\"");
        
        
        let json = serde_json::to_string(&ItemSlot::PDA).unwrap();
        assert_eq!(json, "\"pda\"");
        let json = serde_json::to_string(&ItemSlot::PDA2).unwrap();
        assert_eq!(json, "\"pda2\"");
    }
}