Document btree's unwrap_unchecked

2020-07-23 20:15:47 +02:00 · 2020-07-23 20:15:47 +02:00 · f42dac0ce0
commit f42dac0ce0
parent d92155bf6a
1 changed files with 3 additions and 0 deletions
--- 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(|| {