Enum tantivy::schema::IndexRecordOption

pub enum IndexRecordOption {
    Basic,
    WithFreqs,
    WithFreqsAndPositions,
}

IndexRecordOption describes an amount information associated to a given indexed field.

It is both used to:

• describe in the schema the amount of information that should be retained during indexing (See TextFieldIndexing.html.set_index_option)
• to request for a given amount of information to be decoded as one goes through a posting list. (See InvertedIndexReader.read_postings)

Variants

Basic

records only the DocIds

WithFreqs

records the document ids as well as the term frequency. The term frequency can help giving better scoring of the documents.

WithFreqsAndPositions

records the document id, the term frequency and the positions of the occurences in the document. Positions are required to run PhraseQueries.

Methods

impl IndexRecordOption

pub fn is_termfreq_enabled(self) -> bool

Returns true iff the term frequency will be encoded.

pub fn is_position_enabled(self) -> bool

Returns true iff the term positions within the document are stored as well.

pub fn has_freq(self) -> bool

Returns true iff this option includes encoding term frequencies.

pub fn has_positions(self) -> bool

Returns true iff this option include encoding term positions.

Trait Implementations

impl Eq for IndexRecordOption

impl Clone for IndexRecordOption

fn clone(&self) -> IndexRecordOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<IndexRecordOption> for IndexRecordOption

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl PartialEq<IndexRecordOption> for IndexRecordOption

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for IndexRecordOption

fn cmp(&self, other: &IndexRecordOption) -> 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 Copy for IndexRecordOption

impl Hash for IndexRecordOption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for IndexRecordOption

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

Formats the value using the given formatter.

impl Serialize for IndexRecordOption

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for IndexRecordOption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.