Document the first/last methods

erickt · Dec 15, 2020 · 4819253 · 4819253
1 parent eca535d
commit 4819253
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/src/map.rs b/src/map.rs
@@ -717,18 +717,30 @@ impl<K, V, S> IndexMap<K, V, S> {
         self.as_entries_mut().get_mut(index).map(Bucket::muts)
     }
 
+    /// Get the first key-value pair
+    ///
+    /// Computes in **O(1)** time.
     pub fn first(&self) -> Option<(&K, &V)> {
         self.as_entries().first().map(Bucket::refs)
     }
 
+    /// Get the first key-value pair, with mutable access to the value
+    ///
+    /// Computes in **O(1)** time.
     pub fn first_mut(&mut self) -> Option<(&K, &mut V)> {
         self.as_entries_mut().first_mut().map(Bucket::ref_mut)
     }
 
+    /// Get the last key-value pair
+    ///
+    /// Computes in **O(1)** time.
     pub fn last(&self) -> Option<(&K, &V)> {
         self.as_entries().last().map(Bucket::refs)
     }
 
+    /// Get the last key-value pair, with mutable access to the value
+    ///
+    /// Computes in **O(1)** time.
     pub fn last_mut(&mut self) -> Option<(&K, &mut V)> {
         self.as_entries_mut().last_mut().map(Bucket::ref_mut)
     }

diff --git a/src/set.rs b/src/set.rs
@@ -602,10 +602,16 @@ impl<T, S> IndexSet<T, S> {
         self.as_entries().get(index).map(Bucket::key_ref)
     }
 
+    /// Get the first value
+    ///
+    /// Computes in **O(1)** time.
     pub fn first(&self) -> Option<&T> {
         self.as_entries().first().map(Bucket::key_ref)
     }
 
+    /// Get the last value
+    ///
+    /// Computes in **O(1)** time.
     pub fn last(&self) -> Option<&T> {
         self.as_entries().last().map(Bucket::key_ref)
     }