Struct tantivy::fastfield::FacetReader
source · [−]pub struct FacetReader { /* private fields */ }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
sourceimpl FacetReader
impl FacetReader
sourcepub 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
MultiValuedFastFieldReaderthat makes it possible to access the list of facet ords for a given document. - a
TermDictionarythat helps associating a facet to an ordinal and vice versa.
sourcepub fn num_facets(&self) -> usize
pub fn num_facets(&self) -> usize
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.
sourcepub fn facet_dict(&self) -> &TermDictionary
pub fn facet_dict(&self) -> &TermDictionary
Accessor for the facet term dictionary.
sourcepub fn facet_from_ord(
&mut self,
facet_ord: TermOrdinal,
output: &mut Facet
) -> Result<()>
pub fn facet_from_ord(
&mut self,
facet_ord: TermOrdinal,
output: &mut Facet
) -> Result<()>
Given a term ordinal returns the term associated to it.
sourcepub fn facet_ords(&self, doc: DocId, output: &mut Vec<u64>)
pub fn facet_ords(&self, doc: DocId, output: &mut Vec<u64>)
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
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