Struct tantivy::fastfield::FacetReader [−][src]
pub struct FacetReader { /* fields omitted */ }
Expand description
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.
Implementations
pub fn new(
term_ords: MultiValuedFastFieldReader<u64>,
term_dict: TermDictionary
) -> FacetReader
pub fn new(
term_ords: MultiValuedFastFieldReader<u64>,
term_dict: TermDictionary
) -> FacetReader
Creates a new FacetReader
.
A facet reader just wraps :
- a
MultiValuedFastFieldReader
that makes it possible to access the list of facet ords for a given document. - a
TermDictionary
that helps associating a facet to an ordinal and vice versa.
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
.
Accessor for the facet term dictionary.
Given a term ordinal returns the term associated to it.
Return the list of facet ordinals associated to a document.
Auto Trait Implementations
impl !RefUnwindSafe for FacetReader
impl Send for FacetReader
impl Sync for FacetReader
impl Unpin for FacetReader
impl !UnwindSafe for FacetReader
Blanket Implementations
Mutably borrows from an owned value. Read more
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
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
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
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