Skip to main content

BloomFilterCascade

Struct BloomFilterCascade 

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

Cascaded bloom filters with decreasing false positive rates

§Design

Organizes multiple bloom filters in a cascade where:

  • First filter (L0): Smallest, catches most negatives quickly
  • Subsequent filters: Progressively lower FPR for items that pass

§Benefits

  • Fast rejection of non-existent keys (first filter catches ~99%)
  • Lower overall FPR than single filter for same memory budget
  • Amortized O(1) lookup with early termination

§Example Configuration

L0: 1% FPR, 100KB  → Catches 99% of negatives
L1: 0.1% FPR, 50KB → Catches 99.9% of remaining
L2: 0.01% FPR, 25KB → Final filter for edge cases
Combined FPR: 0.01 * 0.001 * 0.0001 = 0.000000001 (1 in billion)

Implementations§

Source§

impl BloomFilterCascade

Source

pub fn new(expected_items: usize, level_fprs: Vec<f64>) -> Self

Create a new cascade with specified levels

§Arguments
  • expected_items - Number of items to store
  • level_fprs - False positive rate for each level (e.g., [0.01, 0.001, 0.0001])
Source

pub fn default_cascade(expected_items: usize) -> Self

Create default 3-level cascade

  • L0: 1% FPR (fast initial check)
  • L1: 0.1% FPR (medium precision)
  • L2: 0.01% FPR (high precision)
Source

pub fn compact(expected_items: usize) -> Self

Create memory-optimized 2-level cascade

Source

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

Insert an item into all cascade levels

Source

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

Check if item might exist (with early termination)

Returns false (definitely not present) as soon as any level returns false. Returns true only if ALL levels return true.

Source

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

Check with level tracking (for debugging/stats)

Source

pub fn combined_fpr(&self) -> f64

Combined theoretical false positive rate

Source

pub fn num_levels(&self) -> usize

Number of cascade levels

Source

pub fn memory_usage(&self) -> usize

Memory usage in bytes

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize to bytes

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserialize from bytes

Trait Implementations§

Source§

impl Debug for BloomFilterCascade

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,