Add docs for MultiFruit and FruitHandle

quickwit-oss · May 4, 2022 · fdea97e · fdea97e
1 parent ebeeaaf
commit fdea97e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/collector/multi_collector.rs b/src/collector/multi_collector.rs
@@ -5,6 +5,7 @@ use super::{Collector, SegmentCollector};
 use crate::collector::Fruit;
 use crate::{DocId, Score, SegmentOrdinal, SegmentReader, TantivyError};
 
+/// MultiFruit keeps Fruits from every nested Collector
 pub struct MultiFruit {
     sub_fruits: Vec<Option<Box<dyn Fruit>>>,
 }
@@ -79,6 +80,7 @@ impl<TSegmentCollector: SegmentCollector> BoxableSegmentCollector
     }
 }
 
+/// FruitHandle stores reference to the corresponding collector inside MultiCollector
 pub struct FruitHandle<TFruit: Fruit> {
     pos: usize,
     _phantom: PhantomData<TFruit>,