Skip to main content

QuotientFilter

Struct QuotientFilter 

Source
pub struct QuotientFilter { /* private fields */ }
Expand description

A Quotient Filter for approximate set membership with deletion support.

Implementations§

Source§

impl QuotientFilter

Source

pub fn new(config: QuotientFilterConfig) -> Self

Create a new Quotient Filter with the given configuration.

Source

pub fn with_defaults() -> Self

Create with default configuration.

Source

pub fn len(&self) -> usize

Number of elements currently stored.

Source

pub fn is_empty(&self) -> bool

Whether the filter is empty.

Source

pub fn load_factor(&self) -> f64

Current load factor (0.0 to 1.0).

Source

pub fn capacity(&self) -> usize

Number of slots (capacity).

Source

pub fn theoretical_fp_rate(&self) -> f64

Theoretical false positive rate at current load.

Source

pub fn insert<T: Hash>(&mut self, item: &T) -> bool

Insert an element. Returns true if newly inserted, false if already present or full.

Source

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

Check if an element might be in the filter.

Returns false for definite non-members (no false negatives). Returns true for probable members (may have false positives due to fingerprint collisions).

Source

pub fn remove<T: Hash>(&mut self, item: &T) -> bool

Remove an element. Returns true if it was found and removed.

Uses backward-shift deletion to maintain probe sequences.

Source

pub fn clear(&mut self)

Clear all elements.

Source

pub fn merge(&mut self, other: &QuotientFilter) -> usize

Merge another filter into this one.

Both filters must have the same q and r values. Returns the number of new elements added.

Trait Implementations§

Source§

impl Clone for QuotientFilter

Source§

fn clone(&self) -> QuotientFilter

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QuotientFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QuotientFilter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.