Enum tantivy_columnar::column_index::ColumnIndex

pub enum ColumnIndex {
    Empty {
        num_docs: u32,
    },
    Full,
    Optional(OptionalIndex),
    Multivalued(MultiValueIndex),
}

Variants

Empty

Fields

num_docs: u32

Full

Optional(OptionalIndex)

Multivalued(MultiValueIndex)

In addition, at index num_rows, an extra value is added containing the overal number of values.

Implementations

impl ColumnIndex

pub fn get_cardinality(&self) -> Cardinality

Returns the cardinality of the column index.

By convention, if the column contains no docs, we consider that it is full.

pub fn has_value(&self, doc_id: DocId) -> bool

Returns true if and only if there are at least one value associated to the row.

pub fn value_row_ids(&self, doc_id: DocId) -> Range<RowId>

pub fn docids_to_rowids( &self, doc_ids: &[DocId], doc_ids_out: &mut Vec<DocId>, row_ids: &mut Vec<RowId> )

Translates a block of docis to row_ids.

returns the row_ids and the matching docids on the same index e.g. DocId In: [0, 5, 6] DocId Out: [0, 0, 6, 6] RowId Out: [0, 1, 2, 3]

pub fn docid_range_to_rowids(&self, doc_id_range: Range<DocId>) -> Range<RowId>

pub fn select_batch_in_place( &self, doc_id_start: DocId, rank_ids: &mut Vec<RowId> )

Trait Implementations

impl Clone for ColumnIndex

fn clone(&self) -> ColumnIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnIndex

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

Formats the value using the given formatter.

impl From<OptionalIndex> for ColumnIndex

fn from(optional_index: OptionalIndex) -> ColumnIndex

Converts to this type from the input type.