crucible-mir: Cite #1223 for more info on CastKind limitations

Currently, `crucible-mir`'s implementation of `CastKind` lags behind the `rustc` API's `CastKind` enum. Let's leave a link to the relevant issue (#1223) as breadcrumbs.
GaloisInc · Jul 18, 2024 · 2909c22 · 2909c22
1 parent c310fcb
commit 2909c22
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/crucible-mir/src/Mir/JSON.hs b/crucible-mir/src/Mir/JSON.hs
@@ -403,7 +403,8 @@ instance FromJSON CastKind where
                                                Just (String "Pointer(MutToConstPointer)") -> pure MutToConstPointer
                                                Just (String "UnsizeVtable") -> UnsizeVtable <$> v .: "vtable"
                                                -- TODO: actually plumb this information through if it is relevant
-                                                --      instead of using Misc
+                                               -- instead of using Misc. See
+                                               -- https://github.com/GaloisInc/crucible/issues/1223
                                                Just (String "PointerExposeAddress") -> pure Misc
                                                Just (String "PointerFromExposedAddress") -> pure Misc
                                                Just (String "DynStar") -> pure Misc

diff --git a/crucible-mir/src/Mir/Mir.hs b/crucible-mir/src/Mir/Mir.hs
@@ -459,7 +459,7 @@ data Vtable = Vtable
     }
     deriving (Show, Eq, Ord, Generic)
 
--- TODO: add other castkinds (see json)
+-- TODO: add other castkinds (see https://github.com/GaloisInc/crucible/issues/1223)
 data CastKind =
     Misc
   | ReifyFnPointer