Clarify iter and range APIs for multiple version skipmaps

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "skl"
-version = "0.22.9"
+version = "0.22.10"
 edition = "2021"
 rust-version = "1.81.0"
 repository = "https://github.com/al8n/skl"

src/dynamic/list/api.rs

@@ -188,15 +188,15 @@ where
     &self,
     version: Version,
   ) -> Option<EntryRef<'_, MaybeTombstone, C, A, RC>> {
-    self.iter_with_tombstone(version).next()
+    self.iter_all(version).next()
   }
 
   /// Returns the last entry in the map.
   pub fn last_with_tombstone(
     &self,
     version: Version,
   ) -> Option<EntryRef<'_, MaybeTombstone, C, A, RC>> {
-    self.iter_with_tombstone(version).last()
+    self.iter_all(version).last()
   }
 
   /// Returns the value associated with the given key, if it exists.
@@ -306,10 +306,7 @@ where
 
   /// Returns a new iterator, this iterator will yield all versions for all entries in the map less or equal to the given version.
   #[inline]
-  pub fn iter_with_tombstone(
-    &self,
-    version: Version,
-  ) -> iterator::Iter<'_, MaybeTombstone, C, A, RC> {
+  pub fn iter_all(&self, version: Version) -> iterator::Iter<'_, MaybeTombstone, C, A, RC> {
     iterator::Iter::new(version, self, true)
   }
 
@@ -329,7 +326,7 @@ where
 
   /// Returns a iterator that within the range, this iterator will yield all versions for all entries in the range less or equal to the given version.
   #[inline]
-  pub fn range_with_tombstone<Q, R>(
+  pub fn range_all<Q, R>(
     &self,
     version: Version,
     range: R,

src/dynamic/multiple_version.rs

@@ -573,10 +573,7 @@ where
       return None;
     }
 
-    self
-      .as_ref()
-      .iter_with_tombstone(version)
-      .seek_upper_bound(upper)
+    self.as_ref().iter_all(version).seek_upper_bound(upper)
   }
 
   /// Returns an `EntryRef` pointing to the lowest element whose key is above the given bound.
@@ -597,10 +594,7 @@ where
       return None;
     }
 
-    self
-      .as_ref()
-      .iter_with_tombstone(version)
-      .seek_lower_bound(lower)
+    self.as_ref().iter_all(version).seek_lower_bound(lower)
   }
 
   /// Returns a new iterator, this iterator will yield the latest version of all entries in the map less or equal to the given version.
@@ -609,13 +603,13 @@ where
     self.as_ref().iter(version)
   }
 
-  /// Returns a new iterator, this iterator will yield all versions for all entries in the map less or equal to the given version.
+  /// Returns a new iterator, this iterator will yield all versions and tombstones for all entries in the map less or equal to the given version.
   #[inline]
-  fn iter_with_tombstone(
+  fn iter_all(
     &self,
     version: Version,
   ) -> Iter<'_, MaybeTombstone, C, Self::Allocator, Self::RefCounter> {
-    self.as_ref().iter_with_tombstone(version)
+    self.as_ref().iter_all(version)
   }
 
   /// Returns a iterator that within the range, this iterator will yield the latest version of all entries in the range less or equal to the given version.
@@ -632,9 +626,9 @@ where
     self.as_ref().range(version, range)
   }
 
-  /// Returns a iterator that within the range, this iterator will yield all versions for all entries in the range less or equal to the given version.
+  /// Returns a iterator that within the range, this iterator will yield all versions and tombstones for all entries in the range less or equal to the given version.
   #[inline]
-  fn range_with_tombstone<Q, R>(
+  fn range_all<Q, R>(
     &self,
     version: Version,
     range: R,
@@ -643,7 +637,7 @@ where
     Q: ?Sized + Borrow<[u8]>,
     R: RangeBounds<Q>,
   {
-    self.as_ref().range_with_tombstone(version, range)
+    self.as_ref().range_all(version, range)
   }
 
   /// Upserts a new key-value pair if it does not yet exist, if the key with the given version already exists, it will update the value.

src/dynamic/unique.rs

@@ -476,7 +476,7 @@ where
     Q: ?Sized + Borrow<[u8]>,
     C: BytesComparator,
   {
-    self.as_ref().iter_with_tombstone(0).seek_upper_bound(upper)
+    self.as_ref().iter_all(0).seek_upper_bound(upper)
   }
 
   /// Returns an `EntryRef` pointing to the lowest element whose key is above the given bound.
@@ -492,7 +492,7 @@ where
     Q: ?Sized + Borrow<[u8]>,
     C: BytesComparator,
   {
-    self.as_ref().iter_with_tombstone(0).seek_lower_bound(lower)
+    self.as_ref().iter_all(0).seek_lower_bound(lower)
   }
 
   /// Returns a new iterator, this iterator will yield only active entries of all entries in the map less or equal to the given version.
@@ -504,7 +504,7 @@ where
   /// Returns a new iterator, this iterator will yield with tombstones for all entries in the map less or equal to the given version.
   #[inline]
   fn iter_with_tombstone(&self) -> Iter<'_, MaybeTombstone, C, Self::Allocator, Self::RefCounter> {
-    self.as_ref().iter_with_tombstone(0)
+    self.as_ref().iter_all(0)
   }
 
   /// Returns a iterator that within the range, this iterator will yield only active entries of all entries in the range less or equal to the given version.
@@ -527,7 +527,7 @@ where
     Q: ?Sized + Borrow<[u8]>,
     R: RangeBounds<Q>,
   {
-    self.as_ref().range_with_tombstone(MIN_VERSION, range)
+    self.as_ref().range_all(MIN_VERSION, range)
   }
 
   /// Upserts a new key-value pair if it does not yet exist, if the key with the given version already exists, it will update the value.

src/generic/list/api.rs

@@ -208,7 +208,7 @@ where
   where
     C: TypeRefQueryComparator<'a, K, K::Ref<'a>>,
   {
-    self.iter_with_tombstone(version).next()
+    self.iter_all(version).next()
   }
 
   /// Returns the last entry in the map.
@@ -219,7 +219,7 @@ where
   where
     C: TypeRefQueryComparator<'a, K, K::Ref<'a>>,
   {
-    self.iter_with_tombstone(version).last()
+    self.iter_all(version).last()
   }
 
   /// Returns the value associated with the given key, if it exists.
@@ -357,10 +357,7 @@ where
     Q: ?Sized,
     C: TypeRefQueryComparator<'a, K, Q>,
   {
-    self
-      .iter_with_tombstone(version)
-      .map()
-      .seek_upper_bound(upper)
+    self.iter_all(version).map().seek_upper_bound(upper)
   }
 
   /// Returns an `EntryRef` pointing to the lowest element whose key is above the given bound.
@@ -374,10 +371,7 @@ where
     Q: ?Sized,
     C: TypeRefQueryComparator<'a, K, Q>,
   {
-    self
-      .iter_with_tombstone(version)
-      .map()
-      .seek_lower_bound(lower)
+    self.iter_all(version).map().seek_lower_bound(lower)
   }
 
   /// Returns a new iterator, this iterator will yield the latest version of all entries in the map less or equal to the given version.
@@ -388,10 +382,7 @@ where
 
   /// Returns a new iterator, this iterator will yield all versions for all entries in the map less or equal to the given version.
   #[inline]
-  pub fn iter_with_tombstone(
-    &self,
-    version: Version,
-  ) -> iterator::Iter<'_, K, V, MaybeTombstone, C, A, RC>
+  pub fn iter_all(&self, version: Version) -> iterator::Iter<'_, K, V, MaybeTombstone, C, A, RC>
 where {
     iterator::Iter::new(version, self, true)
   }
@@ -412,7 +403,7 @@ where {
 
   /// Returns a iterator that within the range, this iterator will yield all versions for all entries in the range less or equal to the given version.
   #[inline]
-  pub fn range_with_tombstone<Q, R>(
+  pub fn range_all<Q, R>(
     &self,
     version: Version,
     range: R,

src/generic/multiple_version.rs

@@ -650,15 +650,15 @@ where
 
   /// Returns a new iterator, this iterator will yield all versions for all entries in the map less or equal to the given version.
   #[inline]
-  fn iter_with_tombstone(
+  fn iter_all(
     &self,
     version: Version,
   ) -> Iter<'_, K, V, MaybeTombstone, C, Self::Allocator, Self::RefCounter>
   where
     K: Type,
     V: Type,
   {
-    self.as_ref().iter_with_tombstone(version)
+    self.as_ref().iter_all(version)
   }
 
   /// Returns a iterator that within the range, this iterator will yield the latest version of all entries in the range less or equal to the given version.
@@ -679,7 +679,7 @@ where
 
   /// Returns a iterator that within the range, this iterator will yield all versions for all entries in the range less or equal to the given version.
   #[inline]
-  fn range_with_tombstone<Q, R>(
+  fn range_all<Q, R>(
     &self,
     version: Version,
     range: R,
@@ -690,7 +690,7 @@ where
     Q: ?Sized,
     R: RangeBounds<Q>,
   {
-    self.as_ref().range_with_tombstone(version, range)
+    self.as_ref().range_all(version, range)
   }
 
   /// Upserts a new key-value pair if it does not yet exist, if the key with the given version already exists, it will update the value.

src/generic/unique.rs

@@ -558,7 +558,7 @@ where
     K: Type,
     V: Type,
   {
-    self.as_ref().iter_with_tombstone(0)
+    self.as_ref().iter_all(0)
   }
 
   /// Returns a iterator that within the range, this iterator will yield only active entries of all entries in the range less or equal to the given version.
@@ -588,7 +588,7 @@ where
     Q: ?Sized,
     R: RangeBounds<Q>,
   {
-    self.as_ref().range_with_tombstone(MIN_VERSION, range)
+    self.as_ref().range_all(MIN_VERSION, range)
   }
 
   /// Upserts a new key-value pair if it does not yet exist, if the key with the given version already exists, it will update the value.