Enum tantivy::schema::IndexRecordOption

pub enum IndexRecordOption {
    Basic,
    WithFreqs,
    WithFreqsAndPositions,
}

IndexRecordOption describes an amount information associated with 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::set_index_option())
• request that 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 occurrences in the document. Positions are required to run a PhraseQuery.

Implementations

impl IndexRecordOption

pub fn has_freq(self) -> bool

Returns true if this option includes encoding term frequencies.

pub fn has_positions(self) -> bool

Returns true if this option include encoding term positions.

pub fn downgrade(&self, other: IndexRecordOption) -> IndexRecordOption

Downgrades to the next level if provided IndexRecordOption is unavailable.

Trait Implementations

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

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

Formats the value using the given formatter.

impl Default for IndexRecordOption

fn default() -> IndexRecordOption

Returns the “default value” for a type.

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.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for IndexRecordOption

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

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

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

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

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

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

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

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

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

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 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 Copy for IndexRecordOption

impl Eq for IndexRecordOption

impl StructuralPartialEq for IndexRecordOption