Document and track extract_if panics

Author: cuviper

src/map.rs

@@ -325,6 +325,9 @@ impl<K, V, S> IndexMap<K, V, S> {
     ///
     /// [`retain`]: IndexMap::retain
     ///
+    /// ***Panics*** if the starting point is greater than the end point or if
+    /// the end point is greater than the length of the map.
+    ///
     /// # Examples
     ///
     /// Splitting a map into even and odd keys, reusing the original map:
@@ -341,6 +344,7 @@ impl<K, V, S> IndexMap<K, V, S> {
     /// assert_eq!(evens, vec![0, 2, 4, 6]);
     /// assert_eq!(odds, vec![1, 3, 5, 7]);
     /// ```
+    #[track_caller]
     pub fn extract_if<F, R>(&mut self, range: R, pred: F) -> ExtractIf<'_, K, V, F>
     where
         F: FnMut(&K, &mut V) -> bool,

src/map/core/extract.rs

@@ -6,6 +6,7 @@ use crate::util::simplify_range;
 use core::ops::RangeBounds;
 
 impl<K, V> IndexMapCore<K, V> {
+    #[track_caller]
     pub(crate) fn extract<R>(&mut self, range: R) -> ExtractCore<'_, K, V>
     where
         R: RangeBounds<usize>,

src/map/iter.rs

@@ -784,6 +784,7 @@ pub struct ExtractIf<'a, K, V, F> {
 }
 
 impl<K, V, F> ExtractIf<'_, K, V, F> {
+    #[track_caller]
     pub(super) fn new<R>(core: &mut IndexMapCore<K, V>, range: R, pred: F) -> ExtractIf<'_, K, V, F>
     where
         R: RangeBounds<usize>,

src/set.rs

@@ -267,6 +267,9 @@ impl<T, S> IndexSet<T, S> {
     ///
     /// [`retain`]: IndexSet::retain
     ///
+    /// ***Panics*** if the starting point is greater than the end point or if
+    /// the end point is greater than the length of the set.
+    ///
     /// # Examples
     ///
     /// Splitting a set into even and odd values, reusing the original set:
@@ -283,6 +286,7 @@ impl<T, S> IndexSet<T, S> {
     /// assert_eq!(evens, vec![0, 2, 4, 6]);
     /// assert_eq!(odds, vec![1, 3, 5, 7]);
     /// ```
+    #[track_caller]
     pub fn extract_if<F, R>(&mut self, range: R, pred: F) -> ExtractIf<'_, T, F>
     where
         F: FnMut(&T) -> bool,

src/set/iter.rs

@@ -639,6 +639,7 @@ pub struct ExtractIf<'a, T, F> {
 }
 
 impl<T, F> ExtractIf<'_, T, F> {
+    #[track_caller]
     pub(super) fn new<R>(core: &mut IndexMapCore<T, ()>, range: R, pred: F) -> ExtractIf<'_, T, F>
     where
         R: RangeBounds<usize>,