Struct tantivy::positions::PositionReader

pub struct PositionReader { /* fields omitted */ }

When accessing the position of a term, we get a positions_idx from the Terminfo. This means we need to skip to the nth positions efficiently.

Blocks are compressed using bitpacking, so skip_read contains the number of bits (values can go from 0bit to 32 bits) required to decompress every block.

A given block obviously takes (128 x num_bit_for_the_block / num_bits_in_a_byte), so skipping a block without decompressing it is just a matter of advancing that many bytes.

Implementations

impl PositionReader

pub fn open(positions_data: OwnedBytes) -> Result<PositionReader>

Open and reads the term positions encoded into the positions_data owned bytes.

pub fn read(&mut self, offset: u64, output: &mut [u32])

Fills a buffer with the positions [offset..offset+output.len()) integers.

This function is optimized to be called with increasing values of offset.

Trait Implementations

impl Clone for PositionReader

fn clone(&self) -> PositionReader

Returns a copy of the value.

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

Performs copy-assignment from source.