/bloombox

A serializable bloom filter library for Rust

Primary LanguageRustMIT LicenseMIT

BloomBox

BloomBox is a serializable Bloom filter implementation using XXHash. A Bloom filter is a space-efficient probabilistic data structure that is used to test whether an element is a member of a set with a predictable false positive rate.

Getting Started

To use BloomBox in your project, add the following to your Cargo.toml file:

[dependencies]
bloombox = { git = "https://github.com/emersonmde/bloombox" }

Usage

Here is a basic example of how to use BloomBox:

use bloombox::BloomFilter;

let mut filter = BloomFilter::new(100, 0.01);
filter.insert(&"item");
assert!(filter.contains(&"item"));

License

This project is licensed under the MIT License - see the LICENSE file for details.