Struct scalable_cuckoo_filter::ScalableCuckooFilter

pub struct ScalableCuckooFilter<T: ?Sized, H = DefaultHasher, R = DefaultRng> { /* private fields */ }

Scalable Cuckoo Filter.

Implementations

impl<T: Hash + ?Sized> ScalableCuckooFilter<T>

pub fn new( initial_capacity_hint: usize, false_positive_probability: f64 ) -> Self

Makes a new ScalableCuckooFilter instance.

This is equivalent to the following expression:

ScalableCuckooFilterBuilder::new()
    .initial_capacity(initial_capacity)
    .false_positive_probability(false_positive_probability)
    .finish()

impl<T: Hash + ?Sized, H: Hasher + Clone, R: Rng> ScalableCuckooFilter<T, H, R>

pub fn len(&self) -> usize

Returns the approximate number of items inserted in this filter.

pub fn is_empty(&self) -> bool

Returns true if this filter contains no items, otherwise false.

pub fn capacity(&self) -> usize

Returns the capacity (i.e., the upper bound of acceptable items count) of this filter.

“capacity” is upper bound of the number of items can be inserted into the filter without resizing.

pub fn bits(&self) -> u64

Returns the number of bits being used for representing this filter.

pub fn contains(&self, item: &T) -> bool

Returns true if this filter may contain item, otherwise false.

pub fn insert(&mut self, item: &T)

Inserts item into this filter.

If the current filter becomes full, it will be expanded automatically.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of this filter as much as possible.

pub fn remove(&mut self, item: &T)

Removes item from this filter.

Trait Implementations

impl<T: Clone + ?Sized, H: Clone, R: Clone> Clone for ScalableCuckooFilter<T, H, R>

fn clone(&self) -> ScalableCuckooFilter<T, H, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized, H: Debug, R: Debug> Debug for ScalableCuckooFilter<T, H, R>

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

Formats the value using the given formatter.