trid 0.3.2-alpha

Turkish citizenship ID number type
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

[![Crates.io](https://img.shields.io/crates/v/trid)](https://crates.io/crates/trid)
[![Build & Test](https://github.com/ssg/trid/actions/workflows/rust.yml/badge.svg)](https://github.com/ssg/trid/actions/workflows/rust.yml)

# trid - Turkish Citizenship ID Number crate

This is my first ever written Rust code derived from my own [TurkishId](https://github.com/ssg/TurkishId) package for .NET. I'm trying to use existing code as an excuse to learn about Rust. Despite constant tackling with 
error messages, Rust has been extremely impressive so far. (How cool are doc-tests!?)

# Usage

The crate provides an `::is_valid(value: &str)` function for validating ID numbers and a `TurkishId` 
type to encompass a Turkish citizenship ID number, so you don't need to validate it constantly and 
pass it around freely.

# Examples


Validate a Turkish citizenship ID number:

```rust
if trid::is_valid("12345678901") {
    // yayyy!
}
```

Try parsing a string into `TurkishId`:

```rust
use trid::TurkishId;

let id : TurkishId = "12345678901".parse()?;
```

# License

Apache License Version 2.0, see LICENSE file for details.