[−][src]Struct tantivy::fastfield::FacetReader
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<u64>,
term_dict: TermDictionary
) -> FacetReader
[src]
term_ords: MultiValueIntFastFieldReader<u64>,
term_dict: TermDictionary
) -> 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
TermDictionary
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) -> &TermDictionary
[src]
Accessor for the facet term dictionary.
pub fn facet_from_ord(
&mut self,
facet_ord: TermOrdinal,
output: &mut Facet
) -> Result<(), Utf8Error>
[src]
&mut self,
facet_ord: TermOrdinal,
output: &mut Facet
) -> Result<(), Utf8Error>
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.
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast for T where
T: Any,
[src]
T: Any,
fn into_any(self: Box<T>) -> Box<dyn Any + 'static>
[src]
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
[src]
fn as_any(&self) -> &(dyn Any + 'static)
[src]
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]
impl<T> DowncastSync for T where
T: Send + Sync + Any,
[src]
T: Send + Sync + Any,
impl<T> Erased for T
[src]
impl<T> From<T> for T
[src]
impl<T> Fruit for T where
T: Send + Downcast,
[src]
T: Send + Downcast,
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,