Struct xorfilter::Xor8

pub struct Xor8<H = RandomState> where
    H: BuildHasher,  { /* fields omitted */ }

Type Xor8 is probabilistic data-structure to test membership of an element in a set.

This implementation has a false positive rate of about 0.3% and a memory usage of less than 9 bits per entry for sizeable sets.

Methods

impl Xor8<RandomState>

pub fn new() -> Self

New Xor8 instance initialized with DefaulHasher.

impl<H> Xor8<H> where
    H: BuildHasher, 

pub fn with_hasher(hash_builder: H) -> Self

New Xor8 instance initialized with supplied hasher.

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

Insert 64-bit digest of a single key. Digest for the key shall be generated using the default-hasher or via hasher supplied via [new_hasher] method.

pub fn populate<T: Hash>(&mut self, keys: &[T])

Populate 64-bit digests for collection of keys. Digest for the key shall be generated using the default-hasher or via hasher supplied via [new_hasher] method.

pub fn populate_keys(&mut self, keys: &[u64])

Populate pre-compute 64-bit digests for keys.

pub fn build(&mut self)

Build bitmap for keys that are insert using [insert] or [populate] method.

pub fn build_keys(&mut self, keys: &[u64])

Build a bitmap for pre-computed 64-bit digests for keys. If any keys where inserted using [insert], [populate], [populate_keys] method shall be ignored.

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

Contains tell you whether the key is likely part of the set.

pub fn contains_key(&self, key: u64) -> bool

impl Xor8

pub fn write_file(&self, path: &OsStr) -> Result<usize>

Write to file in binary format TODO Add chechsum of finger_prints into file headers

pub fn read_file(path: &OsStr) -> Result<Self>

Read from file in binary format

Trait Implementations

impl Default for Xor8<RandomState>

fn default() -> Self

New Xor8 instance initialized with DefaulHasher.

impl<H> PartialEq<Xor8<H>> for Xor8<H> where
    H: BuildHasher, 

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.