12 releases (5 breaking)

0.6.0 Jan 25, 2024
0.5.3 Jan 25, 2024
0.4.2 Jan 24, 2024
0.3.0 Jan 7, 2024
0.1.0 Feb 4, 2020

#665 in Command line utilities

MIT license

71KB
228 lines

About

File hash checker represents a minimal solution meeting the following requirements:

  • Calculate the SHA256 or BLAKE3 hashes of one or more files in sequence (for loop, iterator) or parallel (threading, messaging, rayon parallel iterator)
  • Provide library API
  • Benchmarks via criterion
  • Minimal dependencies: blake3, sha2, anyhow, clap, rayon
  • Provide a CLI utiility:
    • Simpler and more straightforward usage than sha256sum, b3sum
    • Save the hash to an adjacent hash file (if it doesn't already exist) (.sha256, .b3)
    • Compare the current hash to an adjacent hash file (if it exists)

Usage

$ fhc -h
File hash checker (SHA256, BLAKE3)

Usage: fhc [OPTIONS] [FILES]...

Arguments:
  [FILES]...  File(s)

Options:
  -a <ALGORITHM>           Algorithm [default: blake3] [possible values: blake3,
                           sha256]
  -p, --process <PROCESS>  Approach for processing multiple files [default:
                           rayon-par-iter] [possible values: rayon-par-iter,
                           sequential-for-loop, sequential-iter, threading,
                           messaging]
  -h, --help               Print help
  -V, --version            Print version

Example

  1. Run fhc against one or more files to calculate and print the SHA256 or BLAKE3 hash for each file to stdout and save in adjacent hash files.
  2. At any later point, run fhc against one or more files with adjacent hash files to re-calculate the hash for each file and report OK if the hashes match and FAILED if the hashes do not match.

Benchmark

Changelog

  • 0.1.0 (2020-02-03): Initial release
  • 0.2.1 (2020-02-09): Produce .sha256 files compatible w/ sha256sum -c
  • 0.2.2 (2020-11-18): Update sha2 crate version
  • 0.3.0 (2024-01-07): Modernize
  • 0.4.0 (2024-01-24): Rename sequential process option to sequentialforloop; add sequentialiter and rayonpariter process options; move most of process option logic from CLI to library via process option functions and the process option run method; add criterion benchmarks; fix changelog; update dependencies
    • 0.4.1 (2024-01-24): Fix readme
    • 0.4.2 (2024-01-24): Fix changelog
  • 0.5.0 (2024-01-24): Add blake3 and -a option
    • 0.5.1 (2024-01-24): Fix readme
    • 0.5.2 (2024-01-25): Fix doc
    • 0.5.3 (2024-01-25): Fix readme
  • 0.6.0 (2024-01-25): Change CLI defaults to -a blake3 and -p rayon-par-iter

Dependencies

~6–16MB
~220K SLoC