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。