iso3166-static 0.4.1

Static ISO3166 Data
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

# ISO 3166 Static Data

[![Crates][crates-image]][crates-link]<!--
-->[![Docs][docs-image]][docs-link]<!--
-->![MSRV 1.88.0][msrv-image]

This crate provides generated enumerations for use as with ISO 3166-1 codes. This crate is both `no-std` and `no-alloc` (with no need/desire to enable them), and supports serde via the `"serde"` feature.

There are three primary objects in this crate:

- [`Numeric`](crate::Numeric) - Numeric country codes.
- [`Alpha2`](crate::Alpha2) - Two-character country codes.
- [`Alpha3`](crate::Alpha3) - Three-character country codes.

## Features

By default, this crate compiles with `serde` enabled, and `alloc` disabled. If your compilation enables the `alloc` feature on the `serde` crate, you should enable it here as well to prevent deserialization failures.

- `default`: Enables the `serde` feature by default.
- `alloc`: Enables the use of the `alloc` crate.
- `serde`: Enables implementations of the [`serde::Deserialize`] and [`serde::Serialize`] traits.

## Examples

```rust
use iso3166_static::{Alpha2, Alpha3, Numeric};

const USA_ALPHA2: &str = "US";

let alpha2 = Alpha2::try_from(USA_ALPHA2).expect("alpha2");
let alpha3 = Alpha3::try_from(alpha2.clone()).expect("alpha3");
let numeric = Numeric::try_from(alpha3.clone()).expect("numeric");

assert_eq!(USA_ALPHA2, alpha2.as_str());
assert_eq!(alpha2, alpha3);
assert_eq!(alpha2, numeric);
assert_eq!(alpha3, numeric);
```

```rust
use core::str::FromStr;
use iso3166_static::{Alpha2, Alpha3, Numeric};

let USA_ALPHA3: &str = "USA";

let numeric = Numeric::UnitedStatesOfAmerica;
let alpha3 = Alpha3::try_from(numeric.clone()).expect("alpha3");
let alpha2 = Alpha2::try_from(numeric.clone()).expect("alpha2");

assert_eq!(alpha3.as_str(), USA_ALPHA3);
assert_eq!(numeric, alpha3);
assert_eq!(numeric, alpha2);
assert_eq!(alpha3, alpha2);
```

[//]: # (badges)

[crates-image]: <https://img.shields.io/crates/v/iso3166-static?style=flat-square>
[crates-link]: <https://crates.io/crates/iso3166-static/0.4.1>
[docs-image]: <https://img.shields.io/docsrs/iso3166-static/0.4.1?style=flat-square>
[docs-link]: <https://docs.rs/iso3166-static/0.4.1/iso3166_static/>
[msrv-image]: https://img.shields.io/crates/msrv/iso3166-static/0.4.1?style=for-the-badge