Struct tantivy::postings::TermInfo

pub struct TermInfo {
    pub doc_freq: u32,
    pub postings_range: Range<usize>,
    pub positions_range: Range<usize>,
}

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

Fields

doc_freq: u32

Number of documents in the segment containing the term

postings_range: Range<usize>

Byte range of the posting list within the postings (.idx) file.

positions_range: Range<usize>

Byte range of the positions of this terms in the positions (.pos) file.

Trait Implementations

impl BinarySerializable for TermInfo

fn serialize<W: Write + ?Sized>(&self, writer: &mut W) -> Result<()>

Serialize

fn deserialize<R: Read>(reader: &mut R) -> Result<Self>

Deserialize

fn num_bytes(&self) -> u64

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 Debug for TermInfo

fn fmt(&self, f: &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 FixedSize for TermInfo

const SIZE_IN_BYTES: usize = 28usize

Size required for the binary serialization of a TermInfo object. This is large, but in practise, TermInfo are encoded in blocks and only the first TermInfo of a block is serialized uncompressed. The subsequent TermInfo are delta encoded and bitpacked.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TermInfo

impl StructuralPartialEq for TermInfo