[![Crates.io](https://img.shields.io/crates/v/jp-prefecture.svg)](https://crates.io/crates/jp-prefecture)
[![Docs.rs](https://docs.rs/jp-prefecture/badge.svg)](https://docs.rs/jp-prefecture)
![Crates.io](https://img.shields.io/crates/l/jp-prefecture)
![Test](https://github.com/itto-ki/jp-prefecture/actions/workflows/test.yml/badge.svg?branch=main)

# jp-prefecture

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 = "3.1.0"
```

and imported to the scope of a block where it's begin called

```rust
use jp_prefecture::prefectures;
```

# Examples

```rust
use jp_prefecture::prefectures;

let tokyo = prefectures::find_by_kanji("東京都");
println!("{:?}", tokyo); // => Ok(Prefecture::Tokyo)
println!("{:?}", tokyo.as_ref().unwrap().kanji()); // => "東京都"
println!("{:?}", tokyo.as_ref().unwrap().kanji_short()); // => "東京"
println!("{:?}", tokyo.as_ref().unwrap().english()); // => "Tokyo"

let tokyo = prefectures::find_by_kanji("東京県"); // uhmmmm...
println!("{:?}", tokyo); // => Err(Error::InvalidPrefectureName("東京県"))
```