mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-01-06 01:02:55 +00:00
fix docs (#1288)
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
//! Module for all bucket aggregations.
|
||||
//!
|
||||
//! Results of final buckets are [BucketEntry](super::agg_result::BucketEntry).
|
||||
//! Results of final buckets are [BucketResult](super::agg_result::BucketResult).
|
||||
//! Results of intermediate buckets are
|
||||
//! [IntermediateBucketEntry](super::intermediate_agg_result::IntermediateBucketEntry)
|
||||
//! [IntermediateBucketResult](super::intermediate_agg_result::IntermediateBucketResult)
|
||||
|
||||
mod range;
|
||||
|
||||
|
||||
@@ -23,12 +23,12 @@ use crate::{DocId, TantivyError};
|
||||
/// to value for each range.
|
||||
///
|
||||
/// Result type is [BucketResult](crate::aggregation::agg_result::BucketResult) with
|
||||
/// [BucketEntryKeyCount](crate::aggregation::agg_result::BucketEntryKeyCount) on the
|
||||
/// [BucketEntryKeyCount](crate::aggregation::agg_result::RangeBucketEntry) on the
|
||||
/// AggregationCollector.
|
||||
///
|
||||
/// Result type is
|
||||
/// [crate::aggregation::intermediate_agg_result::IntermediateBucketResult] with
|
||||
/// [crate::aggregation::intermediate_agg_result::IntermediateBucketEntryKeyCount] on the
|
||||
/// [crate::aggregation::intermediate_agg_result::IntermediateRangeBucketEntry] on the
|
||||
/// DistributedAggregationCollector.
|
||||
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
|
||||
pub struct RangeAggregation {
|
||||
|
||||
@@ -122,7 +122,7 @@ impl IndexReaderBuilder {
|
||||
|
||||
/// Sets the number of [Searcher] to pool.
|
||||
///
|
||||
/// See [Self::searcher()].
|
||||
/// See [IndexReader::searcher()].
|
||||
#[must_use]
|
||||
pub fn num_searchers(mut self, num_searchers: usize) -> IndexReaderBuilder {
|
||||
self.num_searchers = num_searchers;
|
||||
|
||||
@@ -10,7 +10,7 @@ pub const GC_INTERVAL: Duration = Duration::from_secs(1);
|
||||
|
||||
/// `Warmer` can be used to maintain segment-level state e.g. caches.
|
||||
///
|
||||
/// They must be registered with the [IndexReaderBuilder].
|
||||
/// They must be registered with the [super::IndexReaderBuilder].
|
||||
pub trait Warmer: Sync + Send {
|
||||
/// Perform any warming work using the provided [Searcher].
|
||||
fn warm(&self, searcher: &Searcher) -> crate::Result<()>;
|
||||
|
||||
Reference in New Issue
Block a user