Moduleghc-9.14.1GHC2021

GHC.Iface.Ext.Binary

3 types
6 values

Packageghc-9.14.1
Exports9
LanguageGHC2021
LicenceBSD-3-Clause
SourceBinary.hs

valuereadHieFile :: NameCache -> FilePath -> IO HieFileResult

Read a HieFile from a FilePath. Can use an existing NameCache.

valuereadHieFileWithVersion

:: HieHeader -> Bool
-> NameCache
-> FilePath
-> IO (Either HieHeader HieFileResult)

Read a HieFile from a FilePath. Can use an existing NameCache. Allows you to specify which versions of hieFile to attempt to read. Left case returns the failing header versions.

typetype HieHeader = (Integer, ByteString)

valuewriteHieFile :: FilePath -> HieFile -> IO ()

Write a HieFile to the given FilePath, with a proper header and symbol tables for Names and FastStrings.

datadata HieName

Name's get converted into HieName's before being written into .hie files. See toHieName and fromHieName for logic on how to convert between these two types.

Constructors

ExternalName !Module !OccName !SrcSpan
LocalName !OccName !SrcSpan
KnownKeyName !Unique

Instances3Eq, Ord, Outputable

Eq HieNameDefined in ghc-9.14.1 · GHC.Iface.Ext.Types
Ord HieNameDefined in ghc-9.14.1 · GHC.Iface.Ext.Types
Outputable HieNameDefined in ghc-9.14.1 · GHC.Iface.Ext.Types

valuetoHieName :: Name -> HieName

datadata HieFileResult

Constructors

HieFileResult
- hie_file_result_version :: Integer
- hie_file_result_ghc_version :: ByteString
- hie_file_result :: HieFile

valuehieMagic :: [Word8]

The header for HIE files - Capital ASCII letters "HIE".

valuehieNameOcc :: HieName -> OccName