Struct SmallBloomFilter

pub struct SmallBloomFilter { /* private fields */ }

A monomorphic wrapper for BloomFilter`s with a size of 256 bytes and 13 hash functions.

Implementations

impl SmallBloomFilter

pub fn new() -> Self

Initialize a blank SmallBloomFilter (i.e. contains no elements).

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let blank = SmallBloomFilter::new();
assert_eq!(SmallBloomFilter::count_ones(&blank), 0);

pub fn try_from_vec(vec: Vec<u8>) -> Result<SmallBloomFilter, JsError>

Attempt to initialize a SmallBloomFilter with a starting array. Fails with a JsError if the Vec is not exactly 256 bytes long.

pub fn byte_count() -> usize

The (constant) size of the underlying BloomFilter in bytes.

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let size = SmallBloomFilter::byte_count();
assert_eq!(size, 13);

pub fn hash_count() -> usize

The number of hashes used in the underlying BloomFilter.

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

assert_eq!(SmallBloomFilter::hash_count(), 256);

pub fn insert_vec(&mut self, new_val: Vec<u8>)

Insert a new elememt into the underlying BloomFilter. This Vec can be of any length.

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let mut bloom = SmallBloomFilter::new();
let item = vec![1, 2, 3, 4, 5];
bloom.insert_vec(item.clone());

assert!(bloom.contains(item.clone()));

pub fn contains(&self, item: Vec<u8>) -> bool

Check if some Vec is in the underlying BloomFilter.

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let mut bloom = SmallBloomFilter::new();
let item = vec![1, 2, 3, 4, 5];
bloom.insert_vec(item.clone());

assert!(bloom.contains(item.clone()));

pub fn count_ones(&self) -> usize

Count how many bits are set to 1 (sometimes called a popcount).

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let mut bloom = SmallBloomFilter::new();
let item1 = vec![1, 2, 3, 4, 5];
bloom.insert_vec(item1.clone());
bloom.insert_vec(item1.clone());
bloom.insert_vec(item1.clone());

let item2 = vec![6, 7];
bloom.insert_vec(item2.clone());

let item3 = vec![8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20];
bloom.insert_vec(item2.clone());

assert!(bloom.count_ones() >= 13);
assert!(bloom.count_ones() <= 3 * 13);

pub fn as_bytes(&self) -> Vec<u8>

Retreive the underlying byte array.

Examples

use deterministic_bloom_wasm::SmallBloomFilter;

let mut bloom = SmallBloomFilter::new();
bloom.insert_vec(vec![1, 2, 3, 4, 5]);

assert_ne!(bloom.as_bytes(), vec![0; 256]);
assert_eq!(bloom.as_bytes().len(), 256);

Trait Implementations

impl Debug for SmallBloomFilter

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

Formats the value using the given formatter.

impl Default for SmallBloomFilter

fn default() -> SmallBloomFilter

Returns the “default value” for a type.

impl From<BloomFilter<256, 13>> for SmallBloomFilter

fn from(bloom: BloomFilter<256, 13>) -> Self

Converts to this type from the input type.

impl From<Box<BloomFilter<256, 13>>> for SmallBloomFilter

fn from(original: Box<BloomFilter<256, 13>>) -> SmallBloomFilter

Converts to this type from the input type.

impl From<SmallBloomFilter> for Box<BloomFilter<256, 13>>

fn from(original: SmallBloomFilter) -> Self

Converts to this type from the input type.

impl From<SmallBloomFilter> for JsValue

fn from(value: SmallBloomFilter) -> Self

Converts to this type from the input type.

impl FromWasmAbi for SmallBloomFilter

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for SmallBloomFilter

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for SmallBloomFilter

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<SmallBloomFilter>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for SmallBloomFilter

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for SmallBloomFilter

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for SmallBloomFilter

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<SmallBloomFilter>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for SmallBloomFilter

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<SmallBloomFilter>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFrom<Vec<u8>> for SmallBloomFilter

type Error = Error

The type returned in the event of a conversion error.

fn try_from(vec: Vec<u8>) -> Result<Self, Error>

Performs the conversion.

impl TryFromJsValue for SmallBloomFilter

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for SmallBloomFilter

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[SmallBloomFilter]>

impl VectorIntoJsValue for SmallBloomFilter

fn vector_into_jsvalue(vector: Box<[SmallBloomFilter]>) -> JsValue

impl VectorIntoWasmAbi for SmallBloomFilter

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[SmallBloomFilter]>) -> Self::Abi

impl WasmDescribe for SmallBloomFilter

fn describe()

impl WasmDescribeVector for SmallBloomFilter

fn describe_vector()

impl SupportsConstructor for SmallBloomFilter

impl SupportsInstanceProperty for SmallBloomFilter

impl SupportsStaticProperty for SmallBloomFilter