https://github.com/oniani/huffman
Huffman's algorithm for lossless data compression
https://github.com/oniani/huffman
compression huffman-coding huffman-compression-algorithm rust serde-json
Last synced: 2 months ago
JSON representation
Huffman's algorithm for lossless data compression
- Host: GitHub
- URL: https://github.com/oniani/huffman
- Owner: oniani
- License: mit
- Created: 2020-12-25T22:33:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-11T22:20:25.000Z (almost 4 years ago)
- Last Synced: 2025-03-02T10:08:12.163Z (2 months ago)
- Topics: compression, huffman-coding, huffman-compression-algorithm, rust, serde-json
- Language: Rust
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Huffman
A pure Rust implementation of the Huffman's algorithm for lossless data
compression.
## Dependencies
- [serde_json](https://docs.rs/serde_json/1.0.59/serde_json/index.html)
## Run
```sh
# Build the program
cargo build --release
# Compression.
# `message.txt` is a file to be encoded, `encoding.txt` is a Huffman
# compression. After a successful run, there should be a file `metadata.json`
# which one. could think of as a key for decoding/decompression the
# encoding/compression.
./target/release/huffman message.txt encoding.txt
# Decompression.
# Make sure `metadata.json` is in the current directory.
# `encoding.txt` is the encoding that was generated in the previous step.
# `decoding.txt` should be a dcompression of `encoding.txt`.
# Notice that `decompress(compress(file)) = file` and hence, `decoding.txt`
# must have the same contents as `message.txt`.
# `--decompress` argument tells the program that the decompression mode is on.
./huffman encoding.txt decoding.txt --decompress
```
## Tests
```
cargo test --release
```
## References
- [Huffman coding](https://en.wikipedia.org/wiki/Huffman_coding)
## License
[MIT License](LICENSE)