Struct sv::util::BloomFilter

pub struct BloomFilter {
    pub filter: Vec<u8>,
    pub num_hash_funcs: usize,
    pub tweak: u32,
}

Bloom filter used by SPV nodes to limit transactions received

Fields

filter: Vec<u8>

Filter bit field

num_hash_funcs: usize

Number of hash functions used

tweak: u32

Random tweak to generate the hash functions

Methods

impl BloomFilter

pub fn new(insert: f64, pr_false_pos: f64) -> Result<BloomFilter>

Creates a new bloom filter

• insert - Number of items expected to be inserted into the bloom filter
• pr_false_pos - Desired probability of a false positive

pub fn add(&mut self, data: &[u8])

Adds data to the bloom filter

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

Probabilistically returns whether the bloom filter contains the given data

There may be false positives, but there won't be false negatives.

pub fn validate(&self) -> Result<()>

Returns whether the BloomFilter is valid

Trait Implementations

impl Serializable<BloomFilter> for BloomFilter

fn read(reader: &mut dyn Read) -> Result<BloomFilter>

Reads the object from serialized form

fn write(&self, writer: &mut dyn Write) -> Result<()>

Writes the object to serialized form

impl Clone for BloomFilter

fn clone(&self) -> BloomFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for BloomFilter

impl Default for BloomFilter

fn default() -> BloomFilter

Returns the "default value" for a type.

impl PartialEq<BloomFilter> for BloomFilter

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

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

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

This method tests for !=.

impl Debug for BloomFilter

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

Formats the value using the given formatter.

impl Hash for BloomFilter

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,

Feeds a slice of this type into the given [Hasher].