Struct tantivy::postings::TermInfo

pub struct TermInfo {
    pub doc_freq: u32,
    pub postings_offset: u64,
    pub positions_offset: u64,
    pub positions_inner_offset: u8,
}

TermInfo contains all of the information associated to terms in the .term file.

It consists of

• doc_freq : the number of document in the segment containing this term. It is also the length of the posting list associated to this term
• postings_offset : an offset in the .idx file addressing the start of the posting list associated to this term.

Fields

doc_freq: u32

Number of documents in the segment containing the term

postings_offset: u64

Offset within the postings (.idx) file.

positions_offset: u64

Offset within the position (.pos) file.

positions_inner_offset: u8

Offset within the position block.

Trait Implementations

impl Debug for TermInfo

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for TermInfo

fn default() -> TermInfo

Returns the "default value" for a type.

impl Ord for TermInfo

fn cmp(&self, __arg_0: &TermInfo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for TermInfo

fn partial_cmp(&self, __arg_0: &TermInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &TermInfo) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &TermInfo) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &TermInfo) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &TermInfo) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TermInfo

impl PartialEq for TermInfo

fn eq(&self, __arg_0: &TermInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &TermInfo) -> bool

This method tests for !=.

impl Clone for TermInfo

fn clone(&self) -> TermInfo

Returns a copy of the value.

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

Performs copy-assignment from source.