tw-id-num
==========

[![CI](https://github.com/magiclen/rust-tw-id-num/actions/workflows/ci.yml/badge.svg)](https://github.com/magiclen/rust-tw-id-num/actions/workflows/ci.yml)

Check or generate Taiwan ID numbers.

檢查或是產生中華民國**國民身分證統一編號**(即**身份證字號**，而非營業人統一編號)，支援**新式外來人口統一證號**。

## Usage

```rust
let id = tw_id_num::generate_national(Some(tw_id_num::Sex::Male)); // e.g. "A123456789"

assert!(tw_id_num::check(&id));
assert!(tw_id_num::check_national(&id));
assert!(!tw_id_num::check_resident(&id));
```

## no_std and the `generate` Feature

This crate can be compiled without std.

In few cases, you may want to generate IDs by yourself. The `generate*` functions are available if the `generate` feature is enabled. But the feature needs std.

```toml
[dependencies.tw-id-num]
version = "*"
features = ["generate"]
```

## Crates.io

https://crates.io/crates/tw-id-num

## Documentation

https://docs.rs/tw-id-num

## License

[MIT](LICENSE)