bitcut 0.1.1

Create and apply binary patches
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

# bitcut

`bitcut` is a simple CLI tool for creating and applying binary patches.

## Motivation
When two binary files are similar, rewriting or transmitting the entire new version can be inefficient. This tool reduces the cost by generating a compact binary patch that represents only the difference. The new file can then be reconstructed by applying the patch to the original.

## Patch Format
A patch is a sequence of opcodes:

* `Copy (0x00, offset, len)`: Copy len bytes from offset in the original file.
* `Add (0x01, len, bytes)`: Add len new bytes directly.

## Patch Generation
The original file is indexed using a sliding window (default: 8 bytes).

The new file is scanned with the same window.

If a match is found in the original file, the longest matching sequence is emitted as a Copy.

Otherwise, unmatched bytes are grouped into an Add.

## Patch Application
To apply a patch:

1. Start with an empty output buffer.
2. Iterate over the patch:
    1. Copy: append bytes from the original file.
    2. Add: append new bytes from the patch.

This reconstructs the new version of the file.

## When to Use
This tool works best when the two binary files are mostly similar — for example, when only small regions have changed.

## Commands

### diff

Creates a binary patch from two files and writes the patch to stdout.

```sh
bitcut diff old_file.bin new_file.bin > patch.bin
```

### patch

Applies a binary patch to a file and writes the result to stdout.

```sh
bitcut patch old_file.bin patch.bin > new_file.bin
```

## Install from sources

```sh
cargo install bitcut
```

## Build

```sh
cargo build --release
```

## Run

```sh
./target/release/bitcut diff a.bin b.bin > patch
./target/release/bitcut patch a.bin patch > b.bin
```