tw_id_num/lib.rs
1/*!
2# tw-id-num
3
4Check or generate Taiwan ID numbers.
5
6檢查或是產生中華民國**國民身分證統一編號**(即**身份證字號**,而非營業人統一編號),支援**新式外來人口統一證號**。
7
8## Usage
9
10```rust
11# #[cfg(feature = "generate")]
12# {
13let id = tw_id_num::generate_national(Some(tw_id_num::Sex::Male)); // e.g. "A123456789"
14
15assert!(tw_id_num::check(&id));
16assert!(tw_id_num::check_national(&id));
17assert!(!tw_id_num::check_resident(&id));
18# }
19```
20
21## no_std and the `generate` Feature
22
23This crate can be compiled without std.
24
25In 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.
26
27```toml
28[dependencies.tw-id-num]
29version = "*"
30features = ["generate"]
31```
32*/
33
34#![cfg_attr(not(feature = "rand"), no_std)]
35
36mod check;
37mod location_values;
38
39#[cfg(feature = "rand")]
40mod generate;
41
42pub use check::*;
43#[cfg(feature = "rand")]
44pub use generate::*;