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

//! # Overview
//! jp-prefecture is an utility library for handling Japanese prefectures.
//!
//! # Getting Started
//! Crate has to be added as dependency to `Cargo.toml`
//! ```toml
//! [dependencies]
//! jp-prefecture = "2.0.0"
//! ```
//! and imported to the scope of a block where it's begin called
//! ```rust
//! use jp_prefecture::prefectures;
//! ```
//!
//! # Examples
//! ```
//! use jp_prefecture::prefectures;
//!
//! let tokyo = prefectures::find_by_kanji("東京都");
//! println!("{:?}", tokyo); // => Ok(Prefecture::Tokyo)
//! println!("{:?}", tokyo.unwrap().kanji()); // => "東京都"
//! println!("{:?}", tokyo.unwrap().kanji_short()); // => "東京"
//! println!("{:?}", tokyo.unwrap().english()); // => "tokyo"
//!
//! let tokyo = prefectures::find_by_kanji("東京県"); // uhmmmm...
//! println!("{:?}", tokyo); // => Err(Error::InvalidPrefectureName("東京県"))
//! ```

mod mapping;
pub mod prefectures;

/// Enum representing errors related to Japanese prefectures
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub enum Error<'a> {
    /// The prefecture code cannot be parsed or is invalid
    #[error("Invalid prefecture code: {0}")]
    InvalidPrefectureCode(u32),
    /// The prefecture name cannot be parsed or is invalid
    #[error("Invalid prefecture name: {0}")]
    InvalidPrefectureName(&'a str),
}