Add comment

dfinity · Oct 25, 2024 · b38d79d · b38d79d
1 parent db8a197
commit b38d79d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/btreemap/iter.rs b/src/btreemap/iter.rs
@@ -29,7 +29,9 @@ where
     // A reference to the map being iterated on.
     map: &'a BTreeMap<K, V, M>,
 
-    // A flag indicating if the cursors have been initialized yet.
+    // A flag indicating if the cursors have been initialized yet. This is needed to distinguish
+    // between the case where the iteration hasn't started yet and the case where the iteration has
+    // finished (in both cases the `cursors` field will be empty).
     cursors_initialized: bool,
 
     // A stack of cursors indicating the current position in the tree.