Document that OccupiedEntry.get() and .get_mut() can panic

havarnov · Feb 13, 2023 · 0eb5d2f · 0eb5d2f
1 parent cdecd15
commit 0eb5d2f
Showing 1 changed file with 13 additions and 2 deletions.
diff --git a/src/entry.rs b/src/entry.rs
@@ -32,8 +32,12 @@ pub enum Entry<'a, K: 'a, V: 'a> {
 
 impl<'a, K: 'a, V: 'a> OccupiedEntry<'a, K, V> {
     /// Gets a reference to the first item in value in the vector corresponding to entry.
+    ///
+    /// # Panics
+    ///
+    /// This method will panic if the key has zero values.
     pub fn get(&self) -> &V {
-        &self.inner.get()[0]
+        self.inner.get().first().expect("no values in entry")
     }
 
     /// Gets a reference to the values (vector) corresponding to entry.
@@ -42,8 +46,15 @@ impl<'a, K: 'a, V: 'a> OccupiedEntry<'a, K, V> {
     }
 
     /// Gets a mut reference to the first item in value in the vector corresponding to entry.
+    ///
+    /// # Panics
+    ///
+    /// This method will panic if the key has zero values.
     pub fn get_mut(&mut self) -> &mut V {
-        &mut self.inner.get_mut()[0]
+        self.inner
+            .get_mut()
+            .first_mut()
+            .expect("no values in entry")
     }
 
     /// Gets a mut reference to the values (vector) corresponding to entry.