Struct tantivy::aggregation::AggregationCollector
source · pub struct AggregationCollector { /* private fields */ }Expand description
Collector for aggregations.
The collector collects all aggregations by the underlying aggregation request.
Implementations§
source§impl AggregationCollector
impl AggregationCollector
sourcepub fn from_aggs(agg: Aggregations, limits: AggregationLimits) -> Self
pub fn from_aggs(agg: Aggregations, limits: AggregationLimits) -> Self
Create collector from aggregation request.
Aggregation fails when the limits in AggregationLimits is exceeded. (memory limit and
bucket limit)
Trait Implementations§
source§impl Collector for AggregationCollector
impl Collector for AggregationCollector
§type Fruit = AggregationResults
type Fruit = AggregationResults
Fruit is the type for the result of our collection.
e.g. usize for the Count collector.§type Child = AggregationSegmentCollector
type Child = AggregationSegmentCollector
Type of the
SegmentCollector associated with this collector.source§fn for_segment(
&self,
segment_local_id: SegmentOrdinal,
reader: &SegmentReader
) -> Result<Self::Child>
fn for_segment( &self, segment_local_id: SegmentOrdinal, reader: &SegmentReader ) -> Result<Self::Child>
set_segment is called before beginning to enumerate
on this segment.source§fn requires_scoring(&self) -> bool
fn requires_scoring(&self) -> bool
Returns true iff the collector requires to compute scores for documents.
source§fn merge_fruits(
&self,
segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit>
) -> Result<Self::Fruit>
fn merge_fruits( &self, segment_fruits: Vec<<Self::Child as SegmentCollector>::Fruit> ) -> Result<Self::Fruit>
Combines the fruit associated with the collection of each segments
into one fruit.
source§fn collect_segment(
&self,
weight: &dyn Weight,
segment_ord: u32,
reader: &SegmentReader
) -> Result<<Self::Child as SegmentCollector>::Fruit>
fn collect_segment( &self, weight: &dyn Weight, segment_ord: u32, reader: &SegmentReader ) -> Result<<Self::Child as SegmentCollector>::Fruit>
Created a segment collector and
Auto Trait Implementations§
impl Freeze for AggregationCollector
impl RefUnwindSafe for AggregationCollector
impl Send for AggregationCollector
impl Sync for AggregationCollector
impl Unpin for AggregationCollector
impl UnwindSafe for AggregationCollector
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.source§fn 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.source§fn 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.