thediff 0.1.1

Difference between 2 files in percentages
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

# thediff

A small Rust crate for calculating how different two files are, expressed as a **percentage**.  
It is useful for file comparison, integrity checks, similarity analysis, or detecting changes
between binary or text files.

---


## Installation

Add the crate to your `Cargo.toml`:

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

---

## Usage

### Compare Two Strings

```rust

use thediff::thediff_strings;

fn main() -> std::io::Result<()> {
    let (diff_percent, same_percent) = thediff_strings("0101010", "01010111")?;
    println!(
        "Different part: {:.2}%, Same part: {:.2}%",
        diff_percent, same_percent
    );
    Ok(())
}

```

### Compare Two Files

```rust
use std::path::Path;

use thediff::thediff_files;

fn main() -> std::io::Result<()> {
    let (diff_percent, same_percent) = thediff_files(Path::new("file1.bin"), Path::new("file2.bin"))?;
    println!(
        "Different part: {:.2}%, Same part: {:.2}%",
        diff_percent, same_percent
    );
    Ok(())
}

```

```rust
use std::path::Path;
use thediff::thediff_files_async;

#[tokio::main]
async fn main() -> std::io::Result<()> {
    let (diff_percent, same_percent) =
        thediff_files_async(
            Path::new("file1.bin"),
            Path::new("file2.bin"),
        )
        .await?;

    println!(
        "Different part: {:.2}%, Same part: {:.2}%",
        diff_percent, same_percent
    );

    Ok(())
}

```

---

## How It Works

The crate compares files **utf8 char by char**:

- Counts how many chars differ
- Handles files of **different sizes**
- Extra bytes in the longer file are treated as differences


### Examples

| File A | File B | Result |
|------|------|--------|
| Identical | Identical | `0%` |
| 50% bytes differ | Same length | `50%` |
| One file empty | Other non-empty | `100%` |

---