Struct cipherstash_client::indexer::bloom_filter::BloomFilter

pub struct BloomFilter { /* private fields */ }

A bloom filter implementation designed to be used with the *FilterMatch index types.

Implementations

impl BloomFilter

pub const K_MIN: usize = 3usize

pub const K_MAX: usize = 16usize

pub const K_DEFAULT: usize = 3usize

pub const M_MIN: u32 = 32u32

pub const M_MAX: u32 = 65_536u32

pub const M_DEFAULT: u32 = 256u32

pub fn opts() -> BloomFilterOps

Create a BloomFilterOps struct used to pass options to the bloom filter.

pub fn new(
    key: [u8; 32],
    opts: BloomFilterOps
) -> Result<Self, CreateBloomFilterError>

Create a new BloomFilter from a given key and filter match index settings.

Example

Create a bloom filter with custom options.

let filter = BloomFilter::new(
  get_key(),
  BloomFilter::opts()
    .with_filter_size(256)
    .with_filter_term_bits(3)
).expect("Expected filter to create");

pub fn with_terms<T: AsRef<str>>(
    self,
    terms: impl IntoIterator<Item = T>
) -> Self

pub fn add_terms<T: AsRef<str>>(&mut self, terms: impl IntoIterator<Item = T>)

pub fn add_single_term(&mut self, term: impl AsRef<str>)

pub fn is_subset(&self, other: &Self) -> bool

Check whether this bloom filter is a subset of another.

pub fn into_vec(self) -> Vec<u16>

Convert the bloom filter into an array of “bits”

pub fn from_key(key: [u8; 32]) -> Self

Create a bloom filter from a key.

Since this method creates a bloom filter with default options it is guaranteed to succeed.

pub fn is_empty(&self) -> bool

Check whether the bloom filter contains no elements

Trait Implementations

impl Debug for BloomFilter

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

Formats the value using the given formatter.