chksum-sha2

Crates.iochksum-sha2
lib.rschksum-sha2
version0.0.0
sourcesrc
created_at2023-12-21 17:38:37.098549
updated_at2023-12-21 17:38:37.098549
descriptionAn implementation of SHA-2 hash functions with a straightforward interface for computing digests of bytes, files, directories, and more.
homepage
repositoryhttps://github.com/chksum-rs/sha2
max_upload_size
id1077285
size24,107
kgolawski (ventaquil)

documentation

README

chksum-sha2

GitHub Build docs.rs MSRV deps.rs unsafe forbidden LICENSE

An implementation of SHA-2 hash functions with a straightforward interface for computing digests of bytes, files, directories, and more.

Setup

To use this crate, add the following entry to your Cargo.toml file in the dependencies section:

[dependencies]
chksum-sha2 = "0.0.0"

Alternatively, you can use the cargo add subcommand:

cargo add chksum-sha2

Usage

Use the chksum function to calcualate digest of file, directory and so on.

use chksum_sha2::sha2_256;

let file = File::open(path)?;
let digest = sha2_256::chksum(file)?;
assert_eq!(
    digest.to_hex_lowercase(),
    "44752f37272e944fd2c913a35342eaccdd1aaf189bae50676b301ab213fc5061"
);

For more usage examples, refer to the documentation available at docs.rs.

Features

Cargo features are used to enable or disable specific algorithm functions.

  • 224 enables SHA-2 224, accessible via the sha2_224 module,
  • 256 enables SHA-2 256, accessible via the sha2_256 module,
  • 384 enables SHA-2 384, accessible via the sha2_384 module,
  • 512 enables SHA-2 512, accessible via the sha2_512 module.

By default all of them are enabled.

To customize your setup, turn off the default features and enable only those that you want in your Cargo.toml file:

[dependencies]
chksum-sha2 = { version = "0.0.0", default-features = no, features = ["256", "512"] }

Alternatively, you can use the cargo add subcommand:

cargo add chksum-sha2 --no-default-features --features 256,512

License

This crate is licensed under the MIT License.

Commit count: 1

cargo fmt