Struct PayloadIndexSet 

pub struct PayloadIndexSet { /* private fields */ }

Set of per-field payload bitmap indexes for a collection.

Implementations

impl PayloadIndexSet

pub fn add_index(&mut self, field: impl Into<String>, kind: PayloadIndexKind)

Register a new field index. Idempotent — safe to call multiple times for the same field (subsequent calls are no-ops).

pub fn is_empty(&self) -> bool

Returns true if any index is registered.

pub fn insert_row(&mut self, node_id: u32, fields: &HashMap<String, Value>)

Insert all indexed fields from fields for node_id.

pub fn delete_row(&mut self, node_id: u32, fields: &HashMap<String, Value>)

Remove all indexed fields for node_id.

pub fn definitions_only(&self) -> Self

A set with the same registered fields and kinds and no rows.

pub fn clear_rows(&mut self)

Drop every node from every index. The registered fields and their kinds stay, so the next insert_row indexes the same columns.

pub fn pre_filter(&self, predicate: &FilterPredicate) -> Option<RoaringBitmap>

Evaluate a filter predicate against the bitmap indexes.

Returns Some(bitmap) when the predicate is fully covered by indexed fields (every leaf field has an index). Returns None when any leaf references an un-indexed field — the caller must then fall back to a full post-filter scan. This avoids silently dropping un-indexed predicates.

pub fn field_names(&self) -> impl Iterator<Item = &str>

Return an iterator over all registered field names.

impl PayloadIndexSet

pub fn to_snapshot(&self) -> PayloadIndexSetSnapshot

Serialize to a snapshot for checkpointing.

pub fn from_snapshot(snap: PayloadIndexSetSnapshot) -> Self

Restore from a checkpoint snapshot.

Trait Implementations

impl Debug for PayloadIndexSet

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

Formats the value using the given formatter.

impl Default for PayloadIndexSet

fn default() -> Self

Returns the “default value” for a type.