Adding `libchibi` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add libchibi

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

libchibi = "0.1.0"

The libchibi library will be automatically available globally. Read the libchibi library documentation.

Back to the crate overview.

Readme

Libchibi

For simplicity and ease of use, this library statically links the original implementation of Chibihash64. The current goal of this library is to provide safe bindings to the implementation and integrate with the Rust standard library's Hasher trait.

Usage

use std::hash::Hasher;
use libchibi::Chibihash;

let mut chibi = Chibihash::new(42);
chibi.write(b"Vyper");
chibi.write(b"GM");
let hash = chibi.finish();
println!("{hash:?}");

 // Basic interface
let chibi = Chibihash::new(42);
let hash = chibi.hash(b"GM");
println!("{hash:?}");

When Not To Use

As stated in the README of the original repository,

The introduction should make it clear on why you'd want to use this. Here are some reasons to avoid using this:

For cryptographic purposes.

For protecting against collision attacks (SipHash is the recommended one for this purpose).

When you need very strong probability against collisions: ChibiHash does very minimal amount of mixing compared to other hashes (e.g xxhash64). And so chances of collision should in theory be higher.""

Origin of Chibihash64

The implementation for the hash function was written by N-R-K and can be found here

Bugs

Please open an issue if you encounter any bugs as this crate makes use of unsafe Rust by its nature.

Adding libchibi library as a dependency

Adding `libchibi` library as a dependency