Enum tantivy::schema::IndexRecordOption
source · [−]pub enum IndexRecordOption {
Basic,
WithFreqs,
WithFreqsAndPositions,
}
Expand description
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.
Implementations
Trait Implementations
sourceimpl Clone for IndexRecordOption
impl Clone for IndexRecordOption
sourcefn clone(&self) -> IndexRecordOption
fn clone(&self) -> IndexRecordOption
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for IndexRecordOption
impl Debug for IndexRecordOption
sourceimpl Default for IndexRecordOption
impl Default for IndexRecordOption
sourceimpl<'de> Deserialize<'de> for IndexRecordOption
impl<'de> Deserialize<'de> for IndexRecordOption
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Hash for IndexRecordOption
impl Hash for IndexRecordOption
sourceimpl Ord for IndexRecordOption
impl Ord for IndexRecordOption
sourceimpl PartialOrd<IndexRecordOption> for IndexRecordOption
impl PartialOrd<IndexRecordOption> for IndexRecordOption
sourcefn partial_cmp(&self, other: &IndexRecordOption) -> Option<Ordering>
fn partial_cmp(&self, other: &IndexRecordOption) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
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
sourceimpl Serialize for IndexRecordOption
impl Serialize for IndexRecordOption
impl Copy for IndexRecordOption
impl Eq for IndexRecordOption
impl StructuralEq for IndexRecordOption
impl StructuralPartialEq for IndexRecordOption
Auto Trait Implementations
impl RefUnwindSafe for IndexRecordOption
impl Send for IndexRecordOption
impl Sync for IndexRecordOption
impl Unpin for IndexRecordOption
impl UnwindSafe for IndexRecordOption
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more