Document btree's unwrap_unchecked

ssomers · ssomers · commit f42dac0ce04e · 2020-09-10T00:25:59.000+02:00
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(|| {

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@ trait Recover<Q: ?Sized> {`
`13`	`13`	`fn replace(&mut self, key: Self::Key) -> Option<Self::Key>;`
`14`	`14`	`}`
`15`	`15`
	`16`	+/// Same purpose as `Option::unwrap` but doesn't always guarantee a panic
	`17`	`+/// if the option contains no value.`
	`18`	`+/// SAFETY: the caller must ensure that the option contains a value.`
`16`	`19`	`#[inline(always)]`
`17`	`20`	`pub unsafe fn unwrap_unchecked<T>(val: Option<T>) -> T {`
`18`	`21`	`val.unwrap_or_else(\|\| {`