Struct tantivy_columnar::BytesColumn

pub struct BytesColumn { /* private fields */ }

Dictionary encoded column.

The column simply gives access to a regular u64-column that, in which the values are term-ordinals.

These ordinals are ids uniquely identify the bytes that are stored in the column. These ordinals are small, and sorted in the same order as the term_ord_column.

Implementations

impl BytesColumn

pub fn empty(num_docs: u32) -> BytesColumn

pub fn ord_to_bytes(&self, ord: u64, output: &mut Vec<u8>) -> Result<bool>

Fills the given output buffer with the term associated to the ordinal ord.

Returns false if the term does not exist (e.g. term_ord is greater or equal to the overll number of terms).

pub fn num_rows(&self) -> RowId

Returns the number of rows in the column.

pub fn term_ords(&self, row_id: RowId) -> impl Iterator<Item = u64> + '_

pub fn ords(&self) -> &Column<u64>

Returns the column of ordinals

pub fn num_terms(&self) -> usize

pub fn dictionary(&self) -> &Dictionary<VoidSSTable>

Trait Implementations

impl Clone for BytesColumn

fn clone(&self) -> BytesColumn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BytesColumn

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

Formats the value using the given formatter.

impl From<BytesColumn> for DynamicColumn

fn from(typed_column: BytesColumn) -> Self

Converts to this type from the input type.

impl From<StrColumn> for BytesColumn

fn from(str_column: StrColumn) -> BytesColumn

Converts to this type from the input type.