Added rustdoc for MultiFruit extract function (#1369)

quickwit-oss · May 12, 2022 · 84869db · 84869db
1 parent 6da2402
commit 84869db
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/collector/multi_collector.rs b/src/collector/multi_collector.rs
@@ -87,6 +87,10 @@ pub struct FruitHandle<TFruit: Fruit> {
 }
 
 impl<TFruit: Fruit> FruitHandle<TFruit> {
+    // Extract a typed fruit off a multifruit.
+    //
+    // This function involves downcasting and can panic if the multifruit was
+    // created using faulty code.
     pub fn extract(self, fruits: &mut MultiFruit) -> TFruit {
         let boxed_fruit = fruits.sub_fruits[self.pos].take().expect("");
         *boxed_fruit