🎨 功能

• 高级哈希特征描述。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

🚧️ 测试

在提交任何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。