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())
}

示例

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

🖥️ 开发

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

# 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

🚧️ 测试

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

# 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-至今 Clay McLeod。