diff --git a/src/collector/facet_collector.rs b/src/collector/facet_collector.rs index 6c9404e7f..cd10cbaf0 100644 --- a/src/collector/facet_collector.rs +++ b/src/collector/facet_collector.rs @@ -398,6 +398,8 @@ impl<'a> Iterator for FacetChildIterator<'a> { } impl FacetCounts { + /// Returns an iterator over all of the facet count pairs inside this result. + /// See the documentation for `FacetCollector` for a usage example. pub fn get(&self, facet_from: T) -> FacetChildIterator<'_> where Facet: From, @@ -417,6 +419,8 @@ impl FacetCounts { FacetChildIterator { underlying } } + /// Returns a vector of top `k` facets with their counts, sorted highest-to-lowest by counts. + /// See the documentation for `FacetCollector` for a usage example. pub fn top_k(&self, facet: T, k: usize) -> Vec<(&Facet, u64)> where Facet: From, diff --git a/src/collector/mod.rs b/src/collector/mod.rs index 73fc432b7..6e567047e 100644 --- a/src/collector/mod.rs +++ b/src/collector/mod.rs @@ -109,6 +109,7 @@ pub use self::tweak_score_top_collector::{ScoreSegmentTweaker, ScoreTweaker}; mod facet_collector; pub use self::facet_collector::FacetCollector; +pub use self::facet_collector::FacetCounts; use crate::query::Weight; mod docset_collector;