Enum AllowedSet 

pub enum AllowedSet {
    All,
    Bitmap(Arc<AllowedBitmap>),
    SortedVec(Arc<Vec<u64>>),
    HashSet(Arc<HashSet<u64>>),
    None,
}

The unified gate for candidate filtering

Every executor MUST check allowed_set.contains(doc_id) before including any result. This is the structural enforcement of pushdown.

Variants

All

All documents are allowed (no filter constraint)

Bitmap(Arc<AllowedBitmap>)

Bitmap representation (efficient for dense sets)

SortedVec(Arc<Vec<u64>>)

Sorted vector (efficient for sparse sets with iteration)

HashSet(Arc<HashSet<u64>>)

Hash set (efficient for random access)

None

No documents allowed (empty result shortcut)

Implementations

impl AllowedSet

pub fn from_bitmap(bitmap: AllowedBitmap) -> Self

Create an AllowedSet from a bitmap

pub fn from_sorted_vec(ids: Vec<u64>) -> Self

Create an AllowedSet from a sorted vector of doc IDs

pub fn from_iter(ids: impl IntoIterator<Item = u64>) -> Self

Create an AllowedSet from an iterator of doc IDs

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

Check if a document ID is allowed

This is the core operation that executors MUST call.

pub fn is_empty(&self) -> bool

Check if this set is empty (no allowed documents)

pub fn is_all(&self) -> bool

Check if this set allows all documents

pub fn cardinality(&self) -> Option<usize>

Get the cardinality (number of allowed documents)

Returns None for All (unknown without universe size)

pub fn selectivity(&self, universe_size: usize) -> f64

Compute selectivity against a universe of size N

Returns |S| / N, the fraction of allowed documents

pub fn intersect(&self, other: &AllowedSet) -> AllowedSet

Intersect with another AllowedSet

pub fn union(&self, other: &AllowedSet) -> AllowedSet

Union with another AllowedSet

pub fn iter(&self) -> AllowedSetIter<'_>

Iterate over allowed document IDs

Note: For All, this returns an empty iterator (unknown universe)

pub fn to_vec(&self) -> Vec<u64>

Convert to a Vec (for small sets)

Trait Implementations

impl Clone for AllowedSet

fn clone(&self) -> AllowedSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllowedSet

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

Formats the value using the given formatter.

impl Default for AllowedSet

fn default() -> Self

Returns the “default value” for a type.