Skip to content

Commit

Permalink
Add an explanation for transmute_unchecked
Browse files Browse the repository at this point in the history
  • Loading branch information
WaffleLapkin committed Nov 7, 2023
1 parent b3d5025 commit 55f8efe
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions compiler/rustc_middle/src/query/erase.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ pub fn erase<T: EraseType>(src: T) -> Erase<T> {
};

Erased::<<T as EraseType>::Result> {
// `transmute_unchecked` is needed here because it does not have `transmute`'s size check

Check failure on line 33 in compiler/rustc_middle/src/query/erase.rs

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

8-line comment block with odd number of backticks
// (and thus allows to transmute between `T`` and `MaybeUninit<T::Result>`) (we do the size
// check ourselves in the `const` block above).
//
// `transmute_copy` is also commonly used for this (and it would work here since
// `EraseType: Copy`), but `transmute_unchecked` better explains the intent.
//
// SAFETY: It is safe to transmute to MaybeUninit for types with the same sizes.
data: unsafe { transmute_unchecked::<T, MaybeUninit<T::Result>>(src) },
}
Expand All @@ -39,6 +46,8 @@ pub fn erase<T: EraseType>(src: T) -> Erase<T> {
#[inline(always)]
pub fn restore<T: EraseType>(value: Erase<T>) -> T {
let value: Erased<<T as EraseType>::Result> = value;
// See comment in `erase` for why we use `transmute_unchecked`.
//
// SAFETY: Due to the use of impl Trait in `Erase` the only way to safely create an instance
// of `Erase` is to call `erase`, so we know that `value.data` is a valid instance of `T` of
// the right size.
Expand Down

0 comments on commit 55f8efe

Please sign in to comment.