Skip to main content

BloomFilter

Struct BloomFilter 

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

A simple Bloom filter for sync negotiation.

Used during sync to quickly determine which entries a peer likely has. False positives are expected (~1% with default parameters); false negatives never occur. Subsequent sync rounds resolve false positives via explicit need lists.

Parameters: num_bits total bits in the bitvec, num_hashes hash functions (derived from BLAKE3 by slicing the 32-byte hash into segments).

Implementations§

Source§

impl BloomFilter

Source

pub fn validate(&self) -> Result<(), String>

S-05: Validate bloom filter dimensions after deserialization. Prevents panics from malformed sync offers (division by zero, out of bounds).

Source

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

Create a new Bloom filter sized for expected_items with the given false positive rate.

Computes optimal bit count and hash count from the standard formulas:

  • m = -n * ln(p) / (ln(2)^2)
  • k = (m/n) * ln(2)
Source

pub fn insert(&mut self, hash: &Hash)

Insert a hash into the filter.

Source

pub fn contains(&self, hash: &Hash) -> bool

Check if a hash might be in the filter.

Returns true if the item is probably present (with false positive rate), false if the item is definitely NOT present.

Source

pub fn count(&self) -> usize

Number of items inserted.

Source

pub fn merge(&mut self, other: &BloomFilter)

Merge another filter into this one (union).

Both filters must have the same dimensions (num_bits, num_hashes).

Source

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

Serialize to MessagePack bytes.

Source

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

Deserialize from MessagePack bytes.

Trait Implementations§

Source§

impl Clone for BloomFilter

Source§

fn clone(&self) -> BloomFilter

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 BloomFilter

Source§

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

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

impl<'de> Deserialize<'de> for BloomFilter

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for BloomFilter

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,