Struct tantivy::postings::TermInfo

pub struct TermInfo {
    pub doc_freq: u32,
    pub postings_offset: u64,
    pub positions_idx: u64,
}

TermInfo wraps the metadata associated to a Term. It is segment-local.

Fields

doc_freq: u32

Number of documents in the segment containing the term

postings_offset: u64

Start offset within the postings (.idx) file.

positions_idx: u64

Start offset of the first block within the position (.pos) file.

Trait Implementations

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.

impl Default for TermInfo

fn default() -> TermInfo

Returns the "default value" for a type.

impl Eq for TermInfo

impl Ord for TermInfo

fn cmp(&self, other: &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.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<TermInfo> for TermInfo

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

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

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

This method tests for !=.

impl PartialOrd<TermInfo> for TermInfo

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

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

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

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

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

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

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

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

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

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

impl Debug for TermInfo

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

Formats the value using the given formatter.

impl StructuralPartialEq for TermInfo

impl StructuralEq for TermInfo