# chksum-core

[![crates.io](https://img.shields.io/crates/v/chksum-core?style=flat-square&logo=rust "crates.io")](https://crates.io/crates/chksum-core)
[![Build](https://img.shields.io/github/actions/workflow/status/chksum-rs/core/rust.yml?branch=master&style=flat-square&logo=github "Build")](https://github.com/chksum-rs/core/actions/workflows/rust.yml)
[![docs.rs](https://img.shields.io/docsrs/chksum-core?style=flat-square&logo=docsdotrs "docs.rs")](https://docs.rs/chksum-core/)
[![MSRV](https://img.shields.io/badge/MSRV-1.70.0-informational?style=flat-square "MSRV")](https://github.com/chksum-rs/core/blob/master/Cargo.toml)
[![deps.rs](https://deps.rs/crate/chksum-core/0.1.0/status.svg?style=flat-square "deps.rs")](https://deps.rs/crate/chksum-core/0.1.0)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square "unsafe forbidden")](https://github.com/rust-secure-code/safety-dance)
[![LICENSE](https://img.shields.io/github/license/chksum-rs/core?style=flat-square "LICENSE")](https://github.com/chksum-rs/core/blob/master/LICENSE)

Core traits and functions for straightforward hash computation of bytes, files, directories and more.

## Setup

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

```toml
[dependencies]
chksum-core = "0.1.0"
```

Alternatively, you can use the [`cargo add`](https://doc.rust-lang.org/cargo/commands/cargo-add.html) subcommand:

```sh
cargo add chksum-core
```

## Features

### Asynchronous Runtime

* `async-runtime-tokio`: Enables async interface for Tokio runtime.

By default, neither of these features is enabled.

## Example Crates

For implementation-specific examples, refer to the source code of the following crates:

* [`chksum-md5`](https://github.com/chksum-rs/md5)
* [`chksum-sha1`](https://github.com/chksum-rs/sha1)
* [`chksum-sha2`](https://github.com/chksum-rs/sha2)
    * [`chksum-sha2-224`](http://github.com/chksum-rs/sha2-224)
    * [`chksum-sha2-256`](http://github.com/chksum-rs/sha2-256)
    * [`chksum-sha2-384`](http://github.com/chksum-rs/sha2-384)
    * [`chksum-sha2-512`](http://github.com/chksum-rs/sha2-512)

## License

This crate is licensed under the MIT License.