Struct Fingerprint 

pub struct Fingerprint { /* private fields */ }

Represents a fingerprint of an item, stored in the crate::CuckooFilter.

Generally, fingerprint access should not be needed for regular filter usage, but it can be useful to confirm if the evicted fingerprint matches a known item.

Examples

use cuckoo_clock::{CuckooFilter, Fingerprint, config::CuckooConfiguration};

let filter = CuckooFilter::new_random(CuckooConfiguration::builder(100_000).build()?);

// ... use filter

if let Some(evicted_fp: Fingerprint) = filter.insert("new_item") {
    if evicted_fp.matches_key("known_item", &filter) {
        println!("Known item was evicted!");
    }
}

Implementations

impl Fingerprint

pub fn matches_key<K: Hash + ?Sized, H: BuildHasher>( &self, key: &K, filter: &CuckooFilter<H>, ) -> bool

Compares this fingerprint to a key. This will only produce correct results if the same filter that produced this fingerprint is passed into this method.

Returns true if this fingerprint matches the key.

Trait Implementations

impl Clone for Fingerprint

fn clone(&self) -> Fingerprint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fingerprint

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

Formats the value using the given formatter.

impl Eq for Fingerprint

impl From<u32> for Fingerprint

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for Fingerprint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Fingerprint

fn eq(&self, other: &Fingerprint) -> 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 StructuralPartialEq for Fingerprint