bloomcalc is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install bloomcalc

It will make the bloomcalc command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall bloomcalc uninstalls.

Adding `bloomcalc` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add bloomcalc

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

bloomcalc = "0.6.0"

The bloomcalc library will be automatically available globally. Read the bloomcalc library documentation.

Back to the crate overview.

Readme

bloomcalc

bloomcalc provides a calculator for bloom filters.

Status

Maintenance track. The library is considered stable and will be put into maintenance mode if unchanged for one year.

Scope

This library provides the basics of a bloom filter with the bloomcalc command.

% target/debug/bloomcalc --prob 0.01
a bloom filter with false positive rate of 0.01 will work best with 6.643856189774724 keys

% target/debug/bloomcalc --card 1000 --prob 0.01
a bloom filter for 1000 items with false positive rate 0.01 will need 9585.058377367439 bits

% target/debug/bloomcalc --card 1000 --bits 10000
a bloom filter for 1000 items with 10000 bits will have a 0.008192549468178963 false positive rate

Warts

None.

Documentation

The latest documentation is always available at docs.rs.

Installing the command-line executable

Adding bloomcalc library as a dependency

Adding `bloomcalc` library as a dependency