Struct Filter

pub struct Filter(/* private fields */);

Inventory filter used for subscriptions and inventory comparison.

The Default instance has all bits set to 1, ie. it will match everything.

Implementations

impl Filter

pub fn new(ids: impl IntoIterator<Item = RepoId>) -> Self

Create a new filter with the given items.

Uses the iterator’s size hint to determine the size of the filter.

pub fn empty() -> Self

Empty filter with nothing set.

pub fn size(&self) -> usize

Size in bytes.

Methods from Deref<Target = BloomFilter<RepoId>>

pub fn insert(&mut self, item: &K)

Set an item in the Bloom filter. This operation is idempotent with regards to each unique item. Each item must implement the Hash trait.

pub fn contains(&self, item: &K) -> bool

Return whether or not a given item is likely in the Bloom filter or not. There is a possibility for a false positive with the probability being under the Bloom filter’s p value, but a false negative will never occur.

pub fn clear(&mut self)

Set all bits to zero.

pub fn bits(&self) -> usize

Return the number of bits in this filter.

pub fn hashes(&self) -> usize

Number of hashes used (k parameter).

pub fn count(&self) -> usize

Count the approximate number of items in the filter.

pub fn similarity(&self, other: &BloomFilter<K>) -> f64

Compute the approximate similarity between two filters using the Jaccard Index.

pub fn overlap(&self, other: &BloomFilter<K>) -> f64

Compute the approximate overlap between two filters using the overlap coefficient.

pub fn union(&self, other: &BloomFilter<K>) -> BloomFilter<K>

Compute the union of two Bloom filters.

pub fn intersection(&self, other: &BloomFilter<K>) -> BloomFilter<K>

Compute the intersection of two Bloom filters.

pub fn is_comparable(&self, other: &BloomFilter<K>) -> bool

Check whether two filters can be compared, intersected and unioned.

pub fn as_bytes(&self) -> &[u8]

Return the underlying bytes storage.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Decode for Filter

fn decode<R: Read + ?Sized>(reader: &mut R) -> Result<Self, Error>

impl Default for Filter

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Filter

type Target = BloomFilter<RepoId>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Filter

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Encode for Filter

fn encode<W: Write + ?Sized>(&self, writer: &mut W) -> Result<usize, Error>

impl From<BloomFilter<RepoId>> for Filter

fn from(bloom: BloomFilter<RepoId>) -> Self

Converts to this type from the input type.

impl PartialEq for Filter

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

impl StructuralPartialEq for Filter