Skip to main content

BloomFilter

Struct BloomFilter 

Source
pub struct BloomFilter {
    pub bits: Vec<u64>,
    pub num_hashes: u32,
    pub bit_count: u64,
}
Expand description

A counting-free Bloom filter backed by a Vec<u64> bit array.

Insert items and test membership with a configurable false-positive rate. Deletions are not supported (standard Bloom filter design).

Fields§

§bits: Vec<u64>

Bit storage (each u64 holds 64 bits).

§num_hashes: u32

Number of independent hash functions.

§bit_count: u64

Total number of bits (length of the logical bit array).

Implementations§

Source§

impl BloomFilter

Source

pub fn new(capacity: usize, false_positive_rate: f32) -> Self

Create a new Bloom filter sized for capacity items at a given false_positive_rate.

Uses the standard formulas:

  • m = -n * ln(p) / (ln(2))^2 (number of bits)
  • k = (m / n) * ln(2) (number of hash functions)
Source

pub fn insert(&mut self, item: &[u8])

Insert item into the filter.

Source

pub fn contains(&self, item: &[u8]) -> bool

Returns true if item may be in the set (possible false positive). Returns false if item is definitely not in the set.

Source

pub fn estimated_count(&self) -> usize

Estimate the number of items inserted using the formula: n̂ = -m / k * ln(1 - X / m) where X is the number of set bits.

Source

pub fn clear(&mut self)

Clear all bits (reset the filter).

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, 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, 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.