Struct AtomicBuilderWithFalsePositiveRate 

pub struct AtomicBuilderWithFalsePositiveRate<S = DefaultHasher> { /* private fields */ }

A Bloom filter builder with an immutable false positive rate.

This type can be used to construct an instance of BloomFilter via the builder pattern.

Examples

use fastbloom::AtomicBloomFilter;

let builder = AtomicBloomFilter::with_false_pos(0.01);

Implementations

impl AtomicBuilderWithFalsePositiveRate

pub fn seed(self, seed: &u128) -> Self

Sets the seed for this builder. The later constructed Bloom filter will use this seed when hashing items.

Examples

use fastbloom::AtomicBloomFilter;

let bloom = AtomicBloomFilter::with_false_pos(0.001).seed(&1).expected_items(100);

impl<S: BuildHasher> AtomicBuilderWithFalsePositiveRate<S>

pub fn hasher<H: BuildHasher>( self, hasher: H, ) -> AtomicBuilderWithFalsePositiveRate<H>

Sets the hasher for this builder. The later constructed AtomicBloomFilter will use this hasher when inserting and checking items.

Examples

use fastbloom::AtomicBloomFilter;
use ahash::RandomState;

let bloom = AtomicBloomFilter::with_false_pos(0.001).hasher(RandomState::default()).expected_items(100);

pub fn expected_items(self, expected_num_items: usize) -> AtomicBloomFilter<S>

“Consumes” this builder, using the provided expected_num_items to return an empty AtomicBloomFilter. The number of hashes is optimized based on expected_num_items to maximize Bloom filter accuracy (minimize false positives chance on AtomicBloomFilter::contains). More or less than expected_num_items may be inserted into Bloom filter.

Examples

use fastbloom::AtomicBloomFilter;

let bloom = AtomicBloomFilter::with_false_pos(0.001).expected_items(500);

pub fn items<I: IntoIterator<IntoIter = impl ExactSizeIterator<Item = impl Hash>>>( self, items: I, ) -> AtomicBloomFilter<S>

“Consumes” this builder and constructs a AtomicBloomFilter containing all values in items. The number of hashes per item and underlying memory is optimized based on items.len() to meet the desired false positive rate.

Examples

use fastbloom::AtomicBloomFilter;

let bloom = AtomicBloomFilter::with_false_pos(0.001).items([1, 2, 3]);

Trait Implementations

impl<S: Clone> Clone for AtomicBuilderWithFalsePositiveRate<S>

fn clone(&self) -> AtomicBuilderWithFalsePositiveRate<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for AtomicBuilderWithFalsePositiveRate<S>

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

Formats the value using the given formatter.

impl<S: BuildHasher> PartialEq for AtomicBuilderWithFalsePositiveRate<S>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: BuildHasher> Eq for AtomicBuilderWithFalsePositiveRate<S>