Struct rsbloom::bloom::BloomFilter
source · pub struct BloomFilter { /* private fields */ }Expand description
A Bloom filter implementation that tracks the total number of set bits along with the underlying bit vector and hashing functions, Murmur3 and xxHash.
Implementations
sourceimpl BloomFilter
impl BloomFilter
sourcepub fn new(approx_items: u64) -> BloomFilter
pub fn new(approx_items: u64) -> BloomFilter
Return a new Bloom filter with a given number of approximate items to set. The default false positive probability is set and defined by DEFAULT_FALSE_POS.
sourcepub fn new_with_rate(approx_items: u64, fp_prob: f64) -> BloomFilter
pub fn new_with_rate(approx_items: u64, fp_prob: f64) -> BloomFilter
Return a new Bloom filter with a given number of approximate items to set and a desired false positive probability.
sourceimpl BloomFilter
impl BloomFilter
sourcepub fn set<T: Hash>(&mut self, obj: &T)
pub fn set<T: Hash>(&mut self, obj: &T)
Set an object in the Bloom filter. This operation is idempotent in regards to each unique object. Each object must implement the Hash trait.
sourcepub fn has<T: Hash>(&self, obj: &T) -> Option<bool>
pub fn has<T: Hash>(&self, obj: &T) -> Option<bool>
Returns a bool reflecting if a given object is ‘most likely’ in the Bloom filter or not. There is a possibility for a false positive with the probability being under the Bloom filter’s p value, but a false negative will never occur.
sourcepub fn num_items_approx(&self) -> u64
pub fn num_items_approx(&self) -> u64
Returns the approximate total number of objects set in the Bloom filter.