Merge pull request #266 from cuviper/doc-capacity

Document the lower-bound semantics of capacity
indexmap-rs · Jun 23, 2023 · b5b2814 · b5b2814
2 parents 74e14da + d3ea289
commit b5b2814
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/map.rs b/src/map.rs
@@ -197,6 +197,11 @@ impl<K, V, S> IndexMap<K, V, S> {
         }
     }
 
+    /// Return the number of elements the map can hold without reallocating.
+    ///
+    /// This number is a lower bound; the map might be able to hold more,
+    /// but is guaranteed to be able to hold at least this many.
+    ///
     /// Computes in **O(1)** time.
     pub fn capacity(&self) -> usize {
         self.core.capacity()

diff --git a/src/set.rs b/src/set.rs
@@ -176,6 +176,11 @@ impl<T, S> IndexSet<T, S> {
         }
     }
 
+    /// Return the number of elements the set can hold without reallocating.
+    ///
+    /// This number is a lower bound; the set might be able to hold more,
+    /// but is guaranteed to be able to hold at least this many.
+    ///
     /// Computes in **O(1)** time.
     pub fn capacity(&self) -> usize {
         self.map.capacity()