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
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

#[macro_use] mod imports; use imports::*;

x!{errors}
x!{abbreviation}
x!{federal_district}
x!{region}
x!{state}
x!{territory}

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

    #[test]
    fn test_from() {
        let _ = USRegion::from(USFederalDistrict::DistrictOfColumbia);
        let _ = USRegion::from(UnitedState::Maryland);
        let _ = USRegion::from(USTerritory::VirginIslands);
        let _: USRegion = USFederalDistrict::DistrictOfColumbia.into();
        let _: USRegion = USTerritory::VirginIslands.into();
        let _: USRegion = UnitedState::Maryland.into();
    }

    #[test]
    fn test_display() {
        assert_eq!(UnitedState::California.to_string(), "California");
        assert_eq!(UnitedState::NewYork.to_string(), "New York");
    }

    #[test]
    fn test_abbreviation() {
        assert_eq!(UnitedState::California.abbreviation(), "CA");
        assert_eq!(UnitedState::NewYork.abbreviation(), "NY");
    }

    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_serialize_abbreviation() {
        let state = UnitedState::California;
        let serialized = serde_json::to_string(&state).unwrap();
        assert_eq!(serialized, "\"CA\"");
    }

    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_deserialize_abbreviation() {
        let deserialized: UnitedState = serde_json::from_str("\"CA\"").unwrap();
        assert_eq!(deserialized, UnitedState::California);
    }

    #[test]
    fn test_state_display() {
        assert_eq!(UnitedState::California.to_string(), "California");
        assert_eq!(UnitedState::NewYork.to_string(), "New York");
        assert_eq!(USFederalDistrict::DistrictOfColumbia.to_string(), "District of Columbia");
    }

    #[test]
    fn test_state_abbreviation() {
        assert_eq!(UnitedState::California.abbreviation(), "CA");
        assert_eq!(UnitedState::NewYork.abbreviation(), "NY");
    }

    #[test]
    fn test_territory_display() {
        assert_eq!(USTerritory::PuertoRico.to_string(), "Puerto Rico");
        assert_eq!(USTerritory::Guam.to_string(), "Guam");
    }

    #[test]
    fn test_territory_abbreviation() {
        assert_eq!(USTerritory::PuertoRico.abbreviation(), "PR");
        assert_eq!(USTerritory::Guam.abbreviation(), "GU");
    }

    #[test]
    fn test_state_try_from() {
        assert_eq!(UnitedState::try_from("ca").unwrap(), UnitedState::California);
        assert_eq!(UnitedState::try_from("CALIFORNIA").unwrap(), UnitedState::California);
        assert_eq!(UnitedState::try_from("Alabama").unwrap(), UnitedState::Alabama);
        assert!(UnitedState::try_from("NotAState").is_err());
    }

    #[test]
    fn test_territory_try_from() {
        assert_eq!(USTerritory::try_from("PR").unwrap(), USTerritory::PuertoRico);
        assert_eq!(USTerritory::try_from("puerto rico").unwrap(), USTerritory::PuertoRico);
        assert_eq!(USTerritory::try_from("GU").unwrap(), USTerritory::Guam);
        assert!(USTerritory::try_from("UnknownPlace").is_err());
    }

    #[test]
    fn test_region_try_from() {
        assert_eq!(USRegion::try_from("CA").unwrap(), USRegion::UnitedState(UnitedState::California));
        assert_eq!(USRegion::try_from("PR").unwrap(), USRegion::USTerritory(USTerritory::PuertoRico));
        assert!(USRegion::try_from("Narnia").is_err());
    }

    // Serialization/Deserialization tests require serde features.
    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_serialize_abbreviation() {
        let state = UnitedState::California;
        let serialized = serde_json::to_string(&state).unwrap();
        assert_eq!(serialized, "\"CA\"");

        let territory = USTerritory::PuertoRico;
        let serialized_t = serde_json::to_string(&territory).unwrap();
        assert_eq!(serialized_t, "\"PR\"");

        let region = USRegion::UnitedState(UnitedState::Iowa);
        let serialized_r = serde_json::to_string(&region).unwrap();
        assert_eq!(serialized_r, "\"IA\"");
    }

    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_deserialize_abbreviation() {
        let deserialized: UnitedState = serde_json::from_str("\"CA\"").unwrap();
        assert_eq!(deserialized, UnitedState::California);

        let deserialized_t: USTerritory = serde_json::from_str("\"PR\"").unwrap();
        assert_eq!(deserialized_t, USTerritory::PuertoRico);

        let deserialized_r: USRegion = serde_json::from_str("\"IA\"").unwrap();
        assert_eq!(deserialized_r, USRegion::UnitedState(UnitedState::Iowa));
    }

    #[test]
    fn test_federal_district_display() {
        assert_eq!(USFederalDistrict::DistrictOfColumbia.to_string(), "District of Columbia");
    }

    #[test]
    fn test_federal_district_abbreviation() {
        assert_eq!(USFederalDistrict::DistrictOfColumbia.abbreviation(), "DC");
    }

    #[test]
    fn test_region_display() {
        let r_state = USRegion::UnitedState(UnitedState::Iowa);
        let r_territory = USRegion::USTerritory(USTerritory::AmericanSamoa);
        let r_district = USRegion::USFederalDistrict(USFederalDistrict::DistrictOfColumbia);
        assert_eq!(r_state.to_string(), "Iowa");
        assert_eq!(r_territory.to_string(), "American Samoa");
        assert_eq!(r_district.to_string(), "District of Columbia");
    }

    #[test]
    fn test_region_abbreviation() {
        let r_state     = USRegion::UnitedState(UnitedState::Ohio);
        let r_territory = USRegion::USTerritory(USTerritory::VirginIslands);
        let r_district  = USRegion::USFederalDistrict(USFederalDistrict::DistrictOfColumbia);
        assert_eq!(r_state.abbreviation(), "OH");
        assert_eq!(r_territory.abbreviation(), "VI");
        assert_eq!(r_district.abbreviation(), "DC");
    }

    #[test]
    fn test_state_from_str() {
        assert_eq!("CA".parse::<UnitedState>().unwrap(), UnitedState::California);
        assert_eq!("california".parse::<UnitedState>().unwrap(), UnitedState::California);
        assert_eq!("New Hampshire".parse::<UnitedState>().unwrap(), UnitedState::NewHampshire);
        assert_eq!("newhampshire".parse::<UnitedState>().unwrap(), UnitedState::NewHampshire); // this fails
        assert_eq!("NH".parse::<UnitedState>().unwrap(), UnitedState::NewHampshire);
        assert!("NotAState".parse::<UnitedState>().is_err());
    }

    #[test]
    fn test_territory_from_str() {
        assert_eq!("PR".parse::<USTerritory>().unwrap(), USTerritory::PuertoRico);
        assert_eq!("puerto rico".parse::<USTerritory>().unwrap(), USTerritory::PuertoRico);
        assert_eq!("PuertoRico".parse::<USTerritory>().unwrap(), USTerritory::PuertoRico); // this fails
        assert_eq!("GU".parse::<USTerritory>().unwrap(), USTerritory::Guam);
        assert!("UnknownPlace".parse::<USTerritory>().is_err());
    }

    #[test]
    fn test_federal_district_from_str() {
        assert_eq!("DC".parse::<USFederalDistrict>().unwrap(), USFederalDistrict::DistrictOfColumbia);
        assert_eq!("district of columbia".parse::<USFederalDistrict>().unwrap(), USFederalDistrict::DistrictOfColumbia);
        assert_eq!("Districtofcolumbia".parse::<USFederalDistrict>().unwrap(), USFederalDistrict::DistrictOfColumbia);
        assert!("District9".parse::<USFederalDistrict>().is_err());
    }

    #[test]
    fn test_region_from_str() {
        assert_eq!("CA".parse::<USRegion>().unwrap(), USRegion::UnitedState(UnitedState::California));
        assert_eq!("PR".parse::<USRegion>().unwrap(), USRegion::USTerritory(USTerritory::PuertoRico));
        assert_eq!("DC".parse::<USRegion>().unwrap(), USRegion::USFederalDistrict(USFederalDistrict::DistrictOfColumbia));
        assert!("Narnia".parse::<USRegion>().is_err());
    }

    #[test]
    fn test_all_regions() {
        let regions = USRegion::all_regions();
        // 50 states + 5 territories + 1 federal district = 56 total
        assert_eq!(regions.len(), 50 + 5 + 1);
    }

    // Serialization/Deserialization tests (require serde features)
    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_serialize_abbreviation() {
        let state = UnitedState::California;
        let serialized = serde_json::to_string(&state).unwrap();
        assert_eq!(serialized, "\"CA\"");

        let territory = USTerritory::PuertoRico;
        let serialized_t = serde_json::to_string(&territory).unwrap();
        assert_eq!(serialized_t, "\"PR\"");

        let district = USFederalDistrict::DistrictOfColumbia;
        let serialized_d = serde_json::to_string(&district).unwrap();
        assert_eq!(serialized_d, "\"DC\"");

        let region = USRegion::UnitedState(UnitedState::Iowa);
        let serialized_r = serde_json::to_string(&region).unwrap();
        assert_eq!(serialized_r, "\"IA\"");
    }

    #[test]
    #[cfg(not(feature = "serde_abbreviation"))]
    fn test_serialize_display() {
        let state = UnitedState::California;
        let serialized = serde_json::to_string(&state).unwrap();
        assert_eq!(serialized, "\"California\"");

        let territory = USTerritory::PuertoRico;
        let serialized_t = serde_json::to_string(&territory).unwrap();
        assert_eq!(serialized_t, "\"Puerto Rico\"");

        let district = USFederalDistrict::DistrictOfColumbia;
        let serialized_d = serde_json::to_string(&district).unwrap();
        assert_eq!(serialized_d, "\"District of Columbia\"");

        let region = USRegion::USTerritory(USTerritory::Guam);
        let serialized_r = serde_json::to_string(&region).unwrap();
        assert_eq!(serialized_r, "\"Guam\"");
    }

    #[test]
    #[cfg(feature = "serde_abbreviation")]
    fn test_deserialize_abbreviation() {
        let deserialized: UnitedState = serde_json::from_str("\"CA\"").unwrap();
        assert_eq!(deserialized, UnitedState::California);

        let deserialized_t: USTerritory = serde_json::from_str("\"PR\"").unwrap();
        assert_eq!(deserialized_t, USTerritory::PuertoRico);

        let deserialized_d: USFederalDistrict = serde_json::from_str("\"DC\"").unwrap();
        assert_eq!(deserialized_d, USFederalDistrict::DistrictOfColumbia);

        let deserialized_r: USRegion = serde_json::from_str("\"IA\"").unwrap();
        assert_eq!(deserialized_r, USRegion::UnitedState(UnitedState::Iowa));
    }

    #[test]
    #[cfg(not(feature = "serde_abbreviation"))]
    fn test_deserialize_display() {
        let deserialized: UnitedState = serde_json::from_str("\"California\"").unwrap();
        assert_eq!(deserialized, UnitedState::California);

        let deserialized_t: USTerritory = serde_json::from_str("\"Puerto Rico\"").unwrap();
        assert_eq!(deserialized_t, USTerritory::PuertoRico);

        let deserialized_d: USFederalDistrict = serde_json::from_str("\"District of Columbia\"").unwrap();
        assert_eq!(deserialized_d, USFederalDistrict::DistrictOfColumbia);

        let deserialized_r: USRegion = serde_json::from_str("\"Guam\"").unwrap();
        assert_eq!(deserialized_r, USRegion::USTerritory(USTerritory::Guam));
    }
}