Struct PayloadIndex 

pub struct PayloadIndex {
    pub field: String,
    pub kind: PayloadIndexKind,
    pub bitmaps: PayloadIndexBitmaps,
}

Bitmap index for a single payload field.

Fields

field: String

The field name this index covers.

kind: PayloadIndexKind

Index kind.

bitmaps: PayloadIndexBitmaps

value → set of node ids. Storage layout depends on kind.

Implementations

impl PayloadIndex

pub fn new(field: impl Into<String>, kind: PayloadIndexKind) -> Self

Create a new empty index for field.

pub fn insert(&mut self, node_id: u32, value: &Value)

Record that node_id has value for this field.

pub fn delete(&mut self, node_id: u32, value: &Value)

Remove node_id from the bitmap for value.

pub fn equality(&self, value: &Value) -> Option<&RoaringBitmap>

Return the bitmap of node ids with field = value, or None if the value has never been inserted (empty set).

pub fn range( &self, low: Option<&Value>, low_inclusive: bool, high: Option<&Value>, high_inclusive: bool, ) -> Option<RoaringBitmap>

Return the union bitmap of all entries whose key falls in [low, high] (with low_inclusive / high_inclusive controlling strictness). None bounds mean “open on that side”. Returns None when this index is not a Range index — the caller falls back to a full post-filter scan.

Trait Implementations

impl Clone for PayloadIndex

fn clone(&self) -> PayloadIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadIndex

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

Formats the value using the given formatter.

impl Default for PayloadIndex

fn default() -> Self

Returns the “default value” for a type.