bitbelay

非加密哈希函数的性能评估工具。

请求功能 · 报告错误 · ⭐ 考虑给仓库加星! ⭐

Bitbelay 是一个测试非加密哈希函数性能和期望特性的框架。该项目之所以命名为这个名字，是因为 (a) 它关注评估哈希函数输出的位特性，以及 (b) "belaying" 引发了 (测试) 工具的意象。

Bitbelay 的设计与其他流行的哈希测试框架有所不同 [1]。例如，它不提供单个二进制文件用于在多个哈希函数上基准性能。相反，它 (a) 由一系列提供高质量哈希函数测试设施的 crate 组成，并且 (b) 允许哈希开发者轻松地将他们的哈希函数包装在用于性能测试的命令行工具中。

命令行工具通常包含用于描述单个哈希函数的设施，并编写和发布。当在 crates.io 或其他地方发布时，惯例是将 crate 和/或相关的命令行工具命名为 bitbelay-[HASHNAME]（例如，bitbelay-ahash 对应于 ahash），以便于识别。

🎨 功能

• 高级散列特征化。 Bitbelay 的主要目标是提供设施以表征非加密散列函数的性能和质量。因此，它包含了一系列精心构建的测试集。
• 多个数据提供者。 Bitbelay 包含多种数据提供者，以便于对不同输入数据类型的散列函数进行评估。这种多样性使得我们能够更全面地了解散列函数在不同场景下的性能。此外，可以将自定义数据提供者无缝集成到框架中。
• 散列函数开发的即插即用测试。 Bitbelay 旨在简化散列函数的开发过程——特别是在 Rust 中！为此，它提供了将散列函数包装为命令行工具的设施，其中可以执行一系列测试。

📚 入门指南

您可以通过 Github 仓库将 bitbelay 添加为依赖项。

cargo add bitbelay

接下来，您可以使用 bitbelay::cli::wrapper() 函数快速包装感兴趣的散列函数，并生成一个用于评估它的命令行工具。在这个例子中，我们只是拉取了 Rust 的 d

use std::hash::RandomState;

pub fn main() -> anyhow::Result<()> {
    bitbelay::cli::wrapper(RandomState::default())
}

示例

您还可以查看 示例，以了解您可以使用此包的各种方式。

🖥️ 开发

要启动开发环境，请使用以下命令。

# Clone the repository
git clone [email protected]:claymcleod/bitbelay.git
cd bitbelay 

# Build the crate in release mode
cargo build --release

# List out the examples
cargo run --release --example

🚧️ 测试

在提交任何拉取请求之前，请确保代码通过以下检查。

# Run the project's tests.
cargo test --all-features

# Ensure the project doesn't have any linting warnings.
cargo clippy --all-features

# Ensure the project passes `cargo fmt`.
cargo fmt --check

# Ensure the docs build successfully.
cargo doc

最低支持的 Rust 版本 (MSRV)

由于 bitbelay 的版本小于 1.0，因此尚未声明 MSRV。

🤝 贡献

欢迎贡献、问题和功能请求！请随意查看 问题页面。

📝 许可证

该项目以您的选择许可为 Apache 2.0 或 MIT。

版权所有 © 2024-Present Clay McLeod。