Skip to main content

MembershipFilter

Struct MembershipFilter 

Source
pub struct MembershipFilter { /* private fields */ }
Expand description

Membership filter backed by a dense bitmap.

Implementations§

Source§

impl MembershipFilter

Source

pub fn new_include(vector_count: u64) -> Self

Create a new include-mode filter with given capacity. All bits start clear.

Source

pub fn new_exclude(vector_count: u64) -> Self

Create a new exclude-mode filter with given capacity. All bits start clear.

Source

pub fn add(&mut self, vector_id: u64)

Add a vector ID to the filter.

Source

pub fn remove(&mut self, vector_id: u64)

Remove a vector ID from the filter.

Source

pub fn contains(&self, vector_id: u64) -> bool

Check if a vector ID is visible through this filter.

In Include mode: visible iff the bit is set. In Exclude mode: visible iff the bit is NOT set.

Source

pub fn member_count(&self) -> u64

Number of set bits (members in the bitmap).

Source

pub fn vector_count(&self) -> u64

Total vector capacity.

Source

pub fn mode(&self) -> FilterMode

Filter mode.

Source

pub fn generation_id(&self) -> u32

Generation ID.

Source

pub fn bump_generation(&mut self)

Increment generation ID.

Source

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

Serialize the bitmap to bytes (just the raw bitmap words).

Source

pub fn deserialize( data: &[u8], header: &MembershipHeader, ) -> Result<Self, RvfError>

Deserialize a MembershipFilter from bitmap bytes and a header.

Source

pub fn to_header(&self) -> MembershipHeader

Build a MembershipHeader for this filter.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.