From 76299b3f42a402aa896b76fccd725f52080f374d Mon Sep 17 00:00:00 2001
From: Miguel Ojeda <ojeda@kernel.org>
Date: Sun, 10 Jan 2021 15:59:17 +0100
Subject: [PATCH] Add `SAFETY` annotations

Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 library/core/src/option.rs | 1 +
 library/core/src/result.rs | 2 ++
 2 files changed, 3 insertions(+)

diff --git a/library/core/src/option.rs b/library/core/src/option.rs
index 18b494b3175..5d34f5ca155 100644
--- a/library/core/src/option.rs
+++ b/library/core/src/option.rs
@@ -455,6 +455,7 @@ impl<T> Option<T> {
         debug_assert!(self.is_some());
         match self {
             Some(val) => val,
+            // SAFETY: the safety contract must be upheld by the caller.
             None => unsafe { hint::unreachable_unchecked() },
         }
     }
diff --git a/library/core/src/result.rs b/library/core/src/result.rs
index a0f5c7746cc..a357750b92f 100644
--- a/library/core/src/result.rs
+++ b/library/core/src/result.rs
@@ -849,6 +849,7 @@ impl<T, E> Result<T, E> {
         debug_assert!(self.is_ok());
         match self {
             Ok(t) => t,
+            // SAFETY: the safety contract must be upheld by the caller.
             Err(_) => unsafe { hint::unreachable_unchecked() },
         }
     }
@@ -879,6 +880,7 @@ impl<T, E> Result<T, E> {
     pub unsafe fn unwrap_err_unchecked(self) -> E {
         debug_assert!(self.is_err());
         match self {
+            // SAFETY: the safety contract must be upheld by the caller.
             Ok(_) => unsafe { hint::unreachable_unchecked() },
             Err(e) => e,
         }