Struct scalable_cuckoo_filter::ScalableCuckooFilterBuilder

pub struct ScalableCuckooFilterBuilder<H = DefaultHasher, R = DefaultRng> { /* fields omitted */ }

Builder for ScalableCuckooFilter.

Implementations

impl ScalableCuckooFilterBuilder<DefaultHasher, DefaultRng>

pub fn new() -> Self

Makes a new ScalableCuckooFilterBuilder instance.

impl<H: Hasher + Clone, R: Rng> ScalableCuckooFilterBuilder<H, R>

pub fn initial_capacity(self, capacity_hint: usize) -> Self

Sets the initial capacity (i.e., the number of estimated maximum items) of this filter.

The default value is 100_000.

pub fn false_positive_probability(self, probability: f64) -> Self

Sets the expected upper bound of the false positive probability of this filter.

The default value is 0.001.

Panics

This method panics if probability is not a non-negative number smaller than or equal to 1.0.

pub fn entries_per_bucket(self, n: usize) -> Self

Sets the number of entries per bucket of this filter.

The default value is 4.

pub fn max_kicks(self, kicks: usize) -> Self

Sets the maximum number of relocations in an insertion.

If this limit exceeded, the filter will be expanded.

The default value is 512.

pub fn hasher<T: Hasher + Clone>(
    self,
    hasher: T
) -> ScalableCuckooFilterBuilder<T, R>

Sets the hasher of this filter.

The default value if DefaultHasher::new().

pub fn rng<T: Rng>(self, rng: T) -> ScalableCuckooFilterBuilder<H, T>

Sets the random number generator of this filter.

The default value is rand::thread_rng().

pub fn finish<T: Hash + ?Sized>(self) -> ScalableCuckooFilter<T, H, R>

Builds a ScalableCuckooFilter instance.

Trait Implementations

impl<H: Debug, R: Debug> Debug for ScalableCuckooFilterBuilder<H, R>

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

Formats the value using the given formatter.

impl Default for ScalableCuckooFilterBuilder

fn default() -> Self

Returns the “default value” for a type.