Rollup merge of #76543 - ssomers:btree_cleanup_4, r=Mark-Simulacrum

Document btree's unwrap_unchecked #74693's second wind
rust-lang · Sep 10, 2020 · 8bf03c3 · 8bf03c3
2 parents ba6e2b3 + f42dac0
commit 8bf03c3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/library/alloc/src/collections/btree/mod.rs b/library/alloc/src/collections/btree/mod.rs
@@ -13,6 +13,9 @@ trait Recover<Q: ?Sized> {
     fn replace(&mut self, key: Self::Key) -> Option<Self::Key>;
 }
 
+/// Same purpose as `Option::unwrap` but doesn't always guarantee a panic
+/// if the option contains no value.
+/// SAFETY: the caller must ensure that the option contains a value.
 #[inline(always)]
 pub unsafe fn unwrap_unchecked<T>(val: Option<T>) -> T {
     val.unwrap_or_else(|| {