Struct BloomFilter 

pub struct BloomFilter { /* private fields */ }

Space-efficient probabilistic membership filter.

False negatives are impossible; false positives occur with probability ≤ the configured false_positive_rate when the number of inserted items does not exceed expected_items.

Implementations

impl BloomFilter

pub fn new(expected_items: usize, false_positive_rate: f64) -> Self

Construct a new BloomFilter optimised for expected_items items and the target false_positive_rate (between 0 and 1 exclusive).

Panics if expected_items == 0 or false_positive_rate is outside (0, 1).

pub fn insert(&mut self, item: &[u8])

Insert item into the filter. After this call contains(item) is guaranteed to return true.

pub fn contains(&self, item: &[u8]) -> bool

Return true if item may be in the set; false means it definitely is not.

pub fn estimate_false_positive_rate(&self) -> f64

Estimate the current false-positive probability given the number of items inserted so far.

Formula: (1 - e^(-k * n / m))^k

pub fn item_count(&self) -> u64

Return the number of items inserted so far.

pub fn num_bits(&self) -> usize

Return the number of addressable bits in the underlying array.

pub fn num_hash_functions(&self) -> u8

Return the number of hash functions used per operation.

Trait Implementations

impl Clone for BloomFilter

fn clone(&self) -> BloomFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BloomFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.