Skip to main content

BloomFilter

Struct BloomFilter 

Source
pub struct BloomFilter { /* private fields */ }

Implementations§

Source§

impl BloomFilter

Source

pub fn new(expected_items: usize, false_positive_rate: f64) -> Self

Create a new Bloom filter

  • expected_items: number of items to be inserted
  • false_positive_rate: desired false positive rate (e.g., 0.01 for 1%)
Source

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

Insert an item into the bloom filter

Source

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

Check if an item might be in the set

Returns true if item might be present (could be false positive) Returns false if item is definitely not present (100% accurate)

Source

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

Serialize to bytes with BLAKE3 checksum for corruption detection

CRITICAL FIX: Adds integrity checksum to detect bit flips, cosmic rays, disk errors, or malicious modification of bloom filter data.

Format v2 (with version header for forward compatibility):

  • Magic number: 4 bytes (“BLM\x02” = 0x424C4D02)
  • Header: num_bits (8) + num_hashes (8) + num_words (8) = 24 bytes
  • Bit data: num_words * 8 bytes
  • Checksum: 32 bytes (BLAKE3 hash of magic + header + data)

Format v1 (legacy, for backward compatibility):

  • Header: num_bits (8) + num_hashes (8) + num_words (8) = 24 bytes
  • Bit data: num_words * 8 bytes
  • Checksum: 32 bytes
Source

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

Deserialize from bytes with checksum validation and version detection

CRITICAL FIX: Validates BLAKE3 checksum to detect bloom filter corruption. If corrupted, returns an error. The caller can then rebuild from the index.

FORWARD COMPATIBILITY: Detects format version via magic number.

  • v2 (with magic “BLM\x02”): New format with version header
  • v1 (no magic): Legacy format, auto-detected by size
Source

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

Deserialize from bytes without checksum validation (for backward compatibility)

Use this for reading old bloom filters that don’t have checksums. New bloom filters should use from_bytes() which validates checksums.

Source

pub fn size_bytes(&self) -> usize

Get size in bytes

Source

pub fn memory_size(&self) -> usize

Get memory size (alias for size_bytes)

Trait Implementations§

Source§

impl Debug for BloomFilter

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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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