Struct tantivy::fastfield::FacetReader
[−]
[src]
pub struct FacetReader { /* fields omitted */ }
The facet reader makes it possible to access the list of facets associated to a given document in a specific segment.
Rather than manipulating Facet
object directly, the API
exposes those in the form of list of Facet
ordinal.
A segment ordinal can then be translated into a facet via
.facet_from_ord(...)
.
Facet ordinals are defined as their position in the sorted list of facets. This ordinal is segment local and only makes sense for a given segment.
Methods
impl FacetReader
[src]
pub fn new(
term_ords: MultiValueIntFastFieldReader,
term_dict: TermDictionaryImpl
) -> FacetReader
[src]
term_ords: MultiValueIntFastFieldReader,
term_dict: TermDictionaryImpl
) -> FacetReader
Creates a new FacetReader
.
A facet reader just wraps :
- a
MultiValueIntFastFieldReader
that makes it possible to access the list of facet ords for a given document. - a
TermDictionaryImpl
that helps associating a facet to an ordinal and vice versa.
pub fn num_facets(&self) -> usize
[src]
Returns the size of the sets of facets in the segment. This does not take in account the documents that may be marked as deleted.
Facet
ordinals range from 0
to num_facets() - 1
.
pub fn facet_dict(&self) -> &TermDictionaryImpl
[src]
Accessor for the facet term dictionary.
pub fn facet_from_ord(&self, facet_ord: TermOrdinal, output: &mut Facet)
[src]
Given a term ordinal returns the term associated to it.
pub fn facet_ords(&mut self, doc: DocId, output: &mut Vec<u64>)
[src]
Return the list of facet ordinals associated to a document.