Enum tantivy::schema::IndexRecordOption [−][src]
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 DocId
s
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
[src]
impl IndexRecordOption
pub fn is_termfreq_enabled(&self) -> bool
[src]
pub fn is_termfreq_enabled(&self) -> bool
Returns true iff the term frequency will be encoded.
pub fn is_position_enabled(&self) -> bool
[src]
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
[src]
pub fn has_freq(&self) -> bool
Returns true iff this option includes encoding term frequencies.
pub fn has_positions(&self) -> bool
[src]
pub fn has_positions(&self) -> bool
Returns true iff this option include encoding term positions.
Trait Implementations
impl Clone for IndexRecordOption
[src]
impl Clone for IndexRecordOption
fn clone(&self) -> IndexRecordOption
[src]
fn clone(&self) -> IndexRecordOption
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Copy for IndexRecordOption
[src]
impl Copy for IndexRecordOption
impl Debug for IndexRecordOption
[src]
impl Debug for IndexRecordOption
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for IndexRecordOption
[src]
impl PartialEq for IndexRecordOption
fn eq(&self, other: &IndexRecordOption) -> bool
[src]
fn eq(&self, other: &IndexRecordOption) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl PartialOrd for IndexRecordOption
[src]
impl PartialOrd for IndexRecordOption
fn partial_cmp(&self, other: &IndexRecordOption) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &IndexRecordOption) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for IndexRecordOption
[src]
impl Ord for IndexRecordOption
fn cmp(&self, other: &IndexRecordOption) -> Ordering
[src]
fn cmp(&self, other: &IndexRecordOption) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl Eq for IndexRecordOption
[src]
impl Eq for IndexRecordOption
impl Hash for IndexRecordOption
[src]
impl Hash for IndexRecordOption
Auto Trait Implementations
impl Send for IndexRecordOption
impl Send for IndexRecordOption
impl Sync for IndexRecordOption
impl Sync for IndexRecordOption