Struct BloomFilter

pub struct BloomFilter { /* private fields */ }

A Bloom Filter.

This implementation uses the Kirsch-Mitzenmacher optimization to derive k hash functions from two hash values, which are in turn derived from a single Digest. This provides efficient hashing for BloomFilter::insert and BloomFilter::contains operations.

Implementations

impl BloomFilter

pub fn new(hashers: NonZeroU8, bits: NonZeroUsize) -> Self

Creates a new BloomFilter with hashers hash functions and bits bits.

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

Inserts an item into the BloomFilter.

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

Checks if an item is possibly in the BloomFilter.

Returns true if the item is probably in the set, and false if it is definitely not.

Trait Implementations

impl Clone for BloomFilter

fn clone(&self) -> BloomFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BloomFilter

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

Formats the value using the given formatter.

impl EncodeSize for BloomFilter

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

impl PartialEq for BloomFilter

fn eq(&self, other: &BloomFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for BloomFilter

type Cfg = (RangeCfg, RangeCfg)

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg( buf: &mut impl Buf, (hashers_cfg, bits_cfg): &Self::Cfg, ) -> Result<Self, CodecError>

Reads a value from the buffer using the provided configuration cfg.

impl Write for BloomFilter

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

impl Eq for BloomFilter

impl StructuralPartialEq for BloomFilter