Trait Column

pub trait Column<T: PartialOrd = u64>: Send + Sync {
    // Required methods
    fn get_val(&self, idx: u32) -> T;
    fn min_value(&self) -> T;
    fn max_value(&self) -> T;
    fn num_vals(&self) -> u32;

    // Provided methods
    fn get_range(&self, start: u64, output: &mut [T]) { ... }
    fn get_docids_for_value_range(
        &self,
        value_range: RangeInclusive<T>,
        doc_id_range: Range<u32>,
        positions: &mut Vec<u32>,
    ) { ... }
    fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = T> + 'a> { ... }
}

Column provides columnar access on a field.

Required Methods

fn get_val(&self, idx: u32) -> T

Return the value associated with the given idx.

This accessor should return as fast as possible.

Panics

May panic if idx is greater than the column length.

fn min_value(&self) -> T

Returns the minimum value for this fast field.

This min_value may not be exact. For instance, the min value does not take in account of possible deleted document. All values are however guaranteed to be higher than .min_value().

fn max_value(&self) -> T

Returns the maximum value for this fast field.

This max_value may not be exact. For instance, the max value does not take in account of possible deleted document. All values are however guaranteed to be higher than .max_value().

fn num_vals(&self) -> u32

The number of values in the column.

Provided Methods

fn get_range(&self, start: u64, output: &mut [T])

Fills an output buffer with the fast field values associated with the DocId going from start to start + output.len().

Panics

Must panic if start + output.len() is greater than the segment’s maxdoc.

fn get_docids_for_value_range( &self, value_range: RangeInclusive<T>, doc_id_range: Range<u32>, positions: &mut Vec<u32>, )

Get the positions of values which are in the provided value range.

Note that position == docid for single value fast fields

fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = T> + 'a>

Returns a iterator over the data

Implementations on Foreign Types

impl<'a, C: Column<T>, T: Copy + PartialOrd> Column<T> for &'a C

fn get_val(&self, idx: u32) -> T

fn min_value(&self) -> T

fn max_value(&self) -> T

fn num_vals(&self) -> u32

fn iter<'b>(&'b self) -> Box<dyn Iterator<Item = T> + 'b>

fn get_range(&self, start: u64, output: &mut [T])

Implementors

impl<'a, T: Copy + PartialOrd + Send + Sync> Column<T> for VecColumn<'a, T>

impl<T> Column<<T as Iterator>::Item> for IterColumn<T>

where T: Iterator + Clone + ExactSizeIterator + Send + Sync, T::Item: PartialOrd,