usa 0.8.0

A Rust library providing typed enums and utilities for working with United States regions, including states, territories, and the federal district.
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

crate::ix!();

/// A region of the United States—this can be a UnitedState, a USTerritory, or a Federal District.
#[derive(FileDownloader,Debug,PartialOrd,Ord,PartialEq,Eq,Hash,Clone,Copy)]
pub enum USRegion {
    UnitedState(UnitedState),
    USTerritory(USTerritory),
    USFederalDistrict(USFederalDistrict),
}

impl Default for USRegion {

    fn default() -> Self {
        Self::USFederalDistrict(USFederalDistrict::default())
    }
}

impl From<UnitedState> for USRegion {
    fn from(x: UnitedState) -> Self {
        USRegion::UnitedState(x)
    }
}

impl From<USTerritory> for USRegion {
    fn from(x: USTerritory) -> Self {
        USRegion::USTerritory(x)
    }
}

impl From<USFederalDistrict> for USRegion {
    fn from(x: USFederalDistrict) -> Self {
        USRegion::USFederalDistrict(x)
    }
}

impl TryFrom<&str> for USRegion {

    type Error = BadInput;

    fn try_from(s: &str) -> Result<Self, Self::Error> {
        Self::from_str(s)
    }
}

impl FromStr for USRegion {
    type Err = BadInput;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // Try state, then territory, then district
        if let Ok(st) = s.parse::<UnitedState>() {
            return Ok(USRegion::UnitedState(st));
        }
        if let Ok(tt) = s.parse::<USTerritory>() {
            return Ok(USRegion::USTerritory(tt));
        }
        if let Ok(fd) = s.parse::<USFederalDistrict>() {
            return Ok(USRegion::USFederalDistrict(fd));
        }
        Err(BadInput::bad(s))
    }
}

impl USRegion {

    pub fn all_regions() -> Vec<USRegion> {
        let mut v = Vec::new();
        for s in UnitedState::iter() {
            v.push(USRegion::UnitedState(s));
        }
        for t in USTerritory::iter() {
            v.push(USRegion::USTerritory(t));
        }
        for d in USFederalDistrict::iter() {
            v.push(USRegion::USFederalDistrict(d));
        }
        v
    }

    pub fn name(&self) -> String {
        self.to_string()
    }
}

impl Display for USRegion {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            USRegion::UnitedState(s) => s.fmt(f),
            USRegion::USTerritory(t) => t.fmt(f),
            USRegion::USFederalDistrict(d) => d.fmt(f),
        }
    }
}

/// Serialization and Deserialization
/// By default (with `serde` and without `serde_abbreviation`), we serialize using Display (full name).
/// With `serde_abbreviation` enabled, we use abbreviations.

#[cfg(not(feature = "serde_abbreviation"))]
impl Serialize for USRegion {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where S: serde::Serializer {
        serializer.serialize_str(&self.to_string())
    }
}

#[cfg(feature = "serde_abbreviation")]
impl Serialize for USRegion {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where S: serde::Serializer {
        serializer.serialize_str(self.abbreviation())
    }
}

impl<'de> Deserialize<'de> for USRegion {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        static ALL_REGIONS: Lazy<Vec<&'static str>> = Lazy::new(|| {
            [
                UnitedState::VARIANTS,
                USTerritory::VARIANTS,
                USFederalDistrict::VARIANTS,
            ]
                .concat()
        });

        let s = String::deserialize(deserializer)?;
        s.parse::<USRegion>().map_err(|_| {
            serde::de::Error::unknown_variant(&s, &ALL_REGIONS)
        })
    }
}

impl From<USRegion> for Country {
    fn from(_value: USRegion) -> Self {
        Country::USA
    }
}