tckimlik 0.1.0

Validate Turkish national identification numbers (T.C. Kimlik No). A faithful port of the algorithm used by python-stdnum. Zero deps, no_std.
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

# tckimlik

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

[![crates.io](https://img.shields.io/crates/v/tckimlik.svg)](https://crates.io/crates/tckimlik)
[![docs.rs](https://docs.rs/tckimlik/badge.svg)](https://docs.rs/tckimlik)
[![CI](https://github.com/trananhtung/tckimlik/actions/workflows/ci.yml/badge.svg)](https://github.com/trananhtung/tckimlik/actions/workflows/ci.yml)
[![license](https://img.shields.io/crates/l/tckimlik.svg)](#license)

**Validate Turkish national identification numbers (T.C. Kimlik No.).**

The Turkish Identification Number (*Türkiye Cumhuriyeti Kimlik Numarası*) is an 11-digit
number assigned to every citizen of Turkey, whose last two digits are check digits. A
faithful Rust port of the algorithm used by
[`python-stdnum`](https://arthurdejong.org/python-stdnum/).

- **Zero dependencies**, **`#![no_std]`**
- `is_valid`, `validate`, `calc_check_digits`, `compact`
- Differential-tested against `python-stdnum` (60k cases)

## Install

```toml
[dependencies]
tckimlik = "0.1"
```

## Usage

```rust
use tckimlik::{is_valid, validate, calc_check_digits};

assert!(is_valid("17291716060"));
assert!(!is_valid("17291716050")); // wrong check digit
assert!(!is_valid("07291716092")); // must not start with 0

assert_eq!(validate(" 17291716060 ").unwrap(), "17291716060"); // trims whitespace
assert_eq!(calc_check_digits("172917160").unwrap(), "60");      // the two check digits
```

The number is valid when it has 11 digits, does not start with `0`, and its last two digits
equal `check1 = (10 - Σ wᵢ·dᵢ) mod 10` and `check2 = (check1 + Σ dᵢ) mod 10` computed over the
first nine digits (weights `3,1,3,1,…`).

## Contributors ✨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome — code, docs, bug reports, ideas, reviews! See the [emoji key](https://allcontributors.org/docs/en/emoji-key) for how each contribution is recognized, and open a PR or issue to get involved.

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trananhtung"><img src="https://avatars.githubusercontent.com/u/30992229?v=4?s=100" width="100px;" alt="Tung Tran"/><br /><sub><b>Tung Tran</b></sub></a><br /><a href="https://github.com/trananhtung/./commits?author=trananhtung" title="Code">💻</a> <a href="#maintenance-trananhtung" title="Maintenance">🚧</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License

Licensed under either of [MIT](LICENSE-MIT) or [Apache-2.0](LICENSE-APACHE) at your option.