{"id":16222664,"url":"https://github.com/claymcleod/bitbelay","last_synced_at":"2025-04-08T01:41:11.607Z","repository":{"id":219009807,"uuid":"747945438","full_name":"claymcleod/bitbelay","owner":"claymcleod","description":"A performance evaluation harness for non-cryptographic hash functions.","archived":false,"fork":false,"pushed_at":"2024-01-26T05:44:15.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-26T14:45:23.392Z","etag":null,"topics":["hash","hashing","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/claymcleod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-25T00:19:39.000Z","updated_at":"2024-04-26T14:45:23.393Z","dependencies_parsed_at":"2024-10-10T12:15:00.770Z","dependency_job_id":"95c1f7e7-7dd9-49a9-88e4-91c7a18b910c","html_url":"https://github.com/claymcleod/bitbelay","commit_stats":null,"previous_names":["claymcleod/bitbelay"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claymcleod%2Fbitbelay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claymcleod%2Fbitbelay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claymcleod%2Fbitbelay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/claymcleod%2Fbitbelay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/claymcleod","download_url":"https://codeload.github.com/claymcleod/bitbelay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247761051,"owners_count":20991533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hash","hashing","rust"],"created_at":"2024-10-10T12:14:52.843Z","updated_at":"2025-04-08T01:41:06.588Z","avatar_url":"https://github.com/claymcleod.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ch1 align=\"center\"\u003e\n    bitbelay\n  \u003c/h1\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/claymcleod/bitbelay/actions/workflows/ci.yml\" target=\"_blank\"\u003e\n      \u003cimg alt=\"CI: Status\" src=\"https://github.com/claymcleod/bitbelay/actions/workflows/ci.yml/badge.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/claymcleod/bitbelay/blob/master/LICENSE-APACHE\" target=\"_blank\"\u003e\n      \u003cimg alt=\"License: Apache 2.0\" src=\"https://img.shields.io/badge/license-Apache 2.0-blue.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/claymcleod/bitbelay/blob/master/LICENSE-MIT\" target=\"_blank\"\u003e\n      \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/license-MIT-blue.svg\" /\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n\n\n  \u003cp align=\"center\"\u003e\n    A performance evaluation harness for non-cryptographic hash functions.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/claymcleod/bitbelay/issues/new?assignees=\u0026title=Descriptive%20Title\u0026labels=enhancement\"\u003eRequest Feature\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/claymcleod/bitbelay/issues/new?assignees=\u0026title=Descriptive%20Title\u0026labels=bug\"\u003eReport Bug\u003c/a\u003e\n    ·\n    ⭐ Consider starring the repo! ⭐\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\nBitbelay is a framework for testing the performance and desirable characteristics of\nnon-cryptographic hashing functions. The project was given this name because (a) it is\nconcerned with evaluating the characteristics of bits output from hash functions and (b)\n[\"belaying\"](https://en.wikipedia.org/wiki/Belaying) evokes imagery of a (test) harness.\n\nBitbelay is designed somewhat differently than other popular hash testing frameworks\n[[1][smhasher]]. For example, it does not a ship a single binary that is used to\nbenchmark performance across multiple hash functions. Instead, it (a) is comprised of a\nfamily of crates that provide high-quality facilities for testing hash functions and (b)\nenables hash developers to easily wrap their hash functions in a command line tool for\nperformance testing.\n\nCommand line tools are generally written and published containing the facilities for\ncharacterizing an individual hash function. When publishing these on\n[crates.io](https://crates.io/) or elsewhere, the convention is to name the crate and/or\nassociated command line tool as `bitbelay-[HASHNAME]` (e.g., `bitbelay-ahash` for\n`ahash`) so that it can be easily identified.\n\n## 🎨 Features\n\n* **Advanced hash characterization.** Bitbelay's primary goal is to provide facilities\n  for characterizing the performance and quality of non-cryptographic hash functions. As\n  such, it contains an extensive set of tests organized into a collection of\n  purpose-built test suites.\n* **Multiple data providers.** Bitbelay includes a range of data providers to facilitate\n  the assessment of hash functions against a variety of input data types. This diversity\n  allows for a more comprehensive understanding of hash function performance across\n  different scenarios. Further, custom data providers can be seamlessly integrated into\n  the framework.\n* **Drop-in testing for hash function development.** Bitbelay aims to ease the process\n  of developing hash functions—especially in Rust! To accomplish this, it includes\n  facilities to easily wrap a hash function as a command-line tool within which a\n  battery of tests can be employed.\n\n## 📚 Getting Started\n\nYou can add `bitbelay` as a dependency via the Github repository. \n\n```bash\ncargo add bitbelay\n```\n\nNext, you can use the `bitbelay::cli::wrapper()` function to quickly wrap a hash\nfunction of interest and produce a command-line tool for evaluating it. For this\nexample, we simply pull in Rust's d\n\n```rust\nuse std::hash::RandomState;\n\npub fn main() -\u003e anyhow::Result\u003c()\u003e {\n    bitbelay::cli::wrapper(RandomState::default())\n}\n```\n\n## Examples\n\nYou can also take a look at the\n[examples](https://github.com/claymcleod/bitbelay/tree/main/bitbelay/examples) to\nget a sense of the various ways you can use the crate.\n\n\n## 🖥️ Development\n\nTo bootstrap a development environment, please use the following commands.\n\n```bash\n# Clone the repository\ngit clone git@github.com:claymcleod/bitbelay.git\ncd bitbelay \n\n# Build the crate in release mode\ncargo build --release\n\n# List out the examples\ncargo run --release --example\n```\n\n## 🚧️ Tests\n\nBefore submitting any pull requests, please make sure the code passes the following\nchecks.\n\n```bash\n# Run the project's tests.\ncargo test --all-features\n\n# Ensure the project doesn't have any linting warnings.\ncargo clippy --all-features\n\n# Ensure the project passes `cargo fmt`.\ncargo fmt --check\n\n# Ensure the docs build successfully.\ncargo doc\n```\n\n## Minumum Supported Rust Version (MSRV)\n\nAs bitbelay is pre-1.0, no MSRV is yet asserted.\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome! Feel free to check [issues\npage](https://github.com/claymcleod/bitbelay/issues).\n\n## 📝 License\n\nThis project is licensed as either [Apache 2.0][license-apache] or [MIT][license-mit] at\nyour discretion.\n\nCopyright © 2024-Present [Clay McLeod](https://github.com/claymcleod).\n\n[license-apache]: https://github.com/claymcleod/bitbelay/blob/master/LICENSE-APACHE\n[license-mit]: https://github.com/claymcleod/bitbelay/blob/master/LICENSE-MIT\n\n[smhasher]: https://github.com/rurban/smhasher","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaymcleod%2Fbitbelay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclaymcleod%2Fbitbelay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclaymcleod%2Fbitbelay/lists"}