luhn_tools 0.2.0

A fast, minimal implementation of the Luhn algorithm.
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

# luhn_rs

[![CI](https://github.com/jrrembert/luhn_rs/workflows/CI/badge.svg)](https://github.com/jrrembert/luhn_rs/actions)
[![codecov](https://codecov.io/gh/jrrembert/luhn_rs/branch/main/graph/badge.svg)](https://codecov.io/gh/jrrembert/luhn_rs)
[![Crates.io](https://img.shields.io/crates/v/luhn_rs.svg)](https://crates.io/crates/luhn_rs)
[![Documentation](https://docs.rs/luhn_rs/badge.svg)](https://docs.rs/luhn_rs)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.65.0-blue.svg)](https://github.com/jrrembert/luhn_rs)

A fast, minimal implementation of the Luhn algorithm.

- Generate Luhn numbers
- Validate Luhn numbers
- Generate random valid Luhn numbers
- No dependencies (except rand for random generation)
- Comprehensive error handling
- Fully tested and benchmarked

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
luhn_rs = "0.2.0"
```

## Usage

```rust
use luhn_rs::{generate, validate, random, GenerateOptions};

// Generate a checksum and return new Luhn number
let result = generate("7992739871", None).unwrap();
assert_eq!(result, "79927398713");

// Generate only the checksum
let options = Some(GenerateOptions { checksum_only: true });
let checksum = generate("7992739871", options).unwrap();
assert_eq!(checksum, "3");

// Validate a Luhn number
assert!(validate("79927398713").unwrap());

// Generate a random valid Luhn number of length 10
let random_number = random("10").unwrap();
assert!(validate(&random_number).unwrap());
```

```bash
# view docs
$ cargo doc --no-deps --open

# run tests
$ cargo test

# run benchmarks
$ cargo bench
```

## Contributing

Contributions welcome! Please feel free to submit a Pull Request.

## License

MIT