about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2020-04-22 12:58:17 +0200
committerRalf Jung <post@ralfj.de>2020-04-22 12:58:17 +0200
commit5449e0f10f84bdf964c5d38e03f11ae2190e94d1 (patch)
tree479fa0e6543b558359062621233e69dbb72f3d50
parent41d5a77ee8fc8dc62a8264b992dfd97dae3be59d (diff)
downloadrust-5449e0f10f84bdf964c5d38e03f11ae2190e94d1.tar.gz
rust-5449e0f10f84bdf964c5d38e03f11ae2190e94d1.zip
comment explaining force_align usage
-rw-r--r--src/librustc_mir/interpret/place.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/librustc_mir/interpret/place.rs b/src/librustc_mir/interpret/place.rs
index 24e6833c2b4..ddfd6ae0b8a 100644
--- a/src/librustc_mir/interpret/place.rs
+++ b/src/librustc_mir/interpret/place.rs
@@ -358,6 +358,9 @@ where
 
     /// Return the "access-checked" version of this `MPlace`, where for non-ZST
     /// this is definitely a `Pointer`.
+    ///
+    /// `force_align` must only be used when correct alignment does not matter,
+    /// like in Stacked Borrows.
     pub fn mplace_access_checked(
         &self,
         mut place: MPlaceTy<'tcx, M::PointerTag>,