hetu 0.9.0

Simple crate for validating and generating Finnish personal identity code (henkilötunnus, hetu)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# Personal identity code validator and generator in Rust

[![Crates.io](https://img.shields.io/crates/v/hetu.svg)](https://crates.io/crates/hetu)
[![Tests](https://github.com/jelovirt/hetu/actions/workflows/test.yml/badge.svg)](https://github.com/jelovirt/hetu/actions/workflows/test.yml)

Simple crate for validating and generating [Finnish Personal Identity Code][1] (henkilötunnus, <abbr>hetu</abbr>).

Supports the [1.1.2023 format](https://dvv.fi/hetu-uudistus).

Works with rust 1.8 stable.

## Usage

Add this to your `Cargo.toml`

```toml
[dependencies.hetu]
git = "https://github.com/jelovirt/hetu.git"
```

To validate a personal identity code:

```rust
extern crate hetu;
use hetu::Ssn;

pub fn main() {
    if Ssn::try_from("121212-121D").is_ok() {
        println!("Valid")
    } else {
        println!("Invalid")
    }
}
```

To generate a personal identity code:

```rust
extern crate hetu;
use hetu::Ssn;

pub fn main() {
    println!("{}", Ssn::generate());
}
```

To generate a personal identity code by pattern:

```rust
extern crate hetu;
use hetu::Ssn;
use hetu::SsnPattern;

pub fn main() {
    let pattern = SsnPattern::parse("111111-111?").unwrap();
    println!("{}", Ssn::generate_by_pattern(pattern).unwrap());
}
```

## CLI

Command line tool `hetu` can be used to either validate or randomly generate
personal identity codes.

To validate a personal identity code:

```bash
$ hetu 121212-121D
$ echo 121212-121D | hetu -
$ hetu 121212-121C
Error: Invalid checksum: expected D
  
  121212-121C
            ^
```

To generate a personal identity code:

```bash
$ hetu
121212-121D
```

To generate a personal identity code by pattern that can contain wildcards:

```bash
$ hetu -p "121212-121?"
121212-121D
$ hetu -p "121212-???D"
121212-028D
$ hetu -p "??????-???D"
241151-028D
```

## Related projects

* [personnummer](https://crates.io/crates/personnummer)
* [kennitala](https://crates.io/crates/kennitala)
* [amka](https://crates.io/crates/amka)

[1]: https://dvv.fi/en/personal-identity-code