ghc-8.4.2: The GHC API

Safe HaskellNone
LanguageHaskell2010

Binary

Contents

Synopsis

Documentation

data Bin a #

Instances
Bounded (Bin a) # 
Instance details

Defined in Binary

Eq (Bin a) # 
Instance details

Defined in Binary

Methods

(==) :: Bin a -> Bin a -> Bool #

(/=) :: Bin a -> Bin a -> Bool #

Ord (Bin a) # 
Instance details

Defined in Binary

Methods

compare :: Bin a -> Bin a -> Ordering #

(<) :: Bin a -> Bin a -> Bool #

(<=) :: Bin a -> Bin a -> Bool #

(>) :: Bin a -> Bin a -> Bool #

(>=) :: Bin a -> Bin a -> Bool #

max :: Bin a -> Bin a -> Bin a #

min :: Bin a -> Bin a -> Bin a #

Show (Bin a) # 
Instance details

Defined in Binary

Methods

showsPrec :: Int -> Bin a -> ShowS Source #

show :: Bin a -> String Source #

showList :: [Bin a] -> ShowS Source #

Binary (Bin a) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Bin a -> IO () #

put :: BinHandle -> Bin a -> IO (Bin (Bin a)) #

get :: BinHandle -> IO (Bin a) #

class Binary a where #

Minimal complete definition

get

Methods

put_ :: BinHandle -> a -> IO () #

put :: BinHandle -> a -> IO (Bin a) #

get :: BinHandle -> IO a #

Instances
Binary Bool # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Bool -> IO () #

put :: BinHandle -> Bool -> IO (Bin Bool) #

get :: BinHandle -> IO Bool #

Binary Char # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Char -> IO () #

put :: BinHandle -> Char -> IO (Bin Char) #

get :: BinHandle -> IO Char #

Binary Int # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Int -> IO () #

put :: BinHandle -> Int -> IO (Bin Int) #

get :: BinHandle -> IO Int #

Binary Int8 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Int8 -> IO () #

put :: BinHandle -> Int8 -> IO (Bin Int8) #

get :: BinHandle -> IO Int8 #

Binary Int16 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Int16 -> IO () #

put :: BinHandle -> Int16 -> IO (Bin Int16) #

get :: BinHandle -> IO Int16 #

Binary Int32 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Int32 -> IO () #

put :: BinHandle -> Int32 -> IO (Bin Int32) #

get :: BinHandle -> IO Int32 #

Binary Int64 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Int64 -> IO () #

put :: BinHandle -> Int64 -> IO (Bin Int64) #

get :: BinHandle -> IO Int64 #

Binary Integer # 
Instance details

Defined in Binary

Binary Word8 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Word8 -> IO () #

put :: BinHandle -> Word8 -> IO (Bin Word8) #

get :: BinHandle -> IO Word8 #

Binary Word16 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Word16 -> IO () #

put :: BinHandle -> Word16 -> IO (Bin Word16) #

get :: BinHandle -> IO Word16 #

Binary Word32 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Word32 -> IO () #

put :: BinHandle -> Word32 -> IO (Bin Word32) #

get :: BinHandle -> IO Word32 #

Binary Word64 # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Word64 -> IO () #

put :: BinHandle -> Word64 -> IO (Bin Word64) #

get :: BinHandle -> IO Word64 #

Binary RuntimeRep # 
Instance details

Defined in Binary

Binary VecCount # 
Instance details

Defined in Binary

Binary VecElem # 
Instance details

Defined in Binary

Binary SomeTypeRep # 
Instance details

Defined in Binary

Binary () # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> () -> IO () #

put :: BinHandle -> () -> IO (Bin ()) #

get :: BinHandle -> IO () #

Binary TyCon # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> TyCon -> IO () #

put :: BinHandle -> TyCon -> IO (Bin TyCon) #

get :: BinHandle -> IO TyCon #

Binary KindRep # 
Instance details

Defined in Binary

Binary TypeLitSort # 
Instance details

Defined in Binary

Binary Fingerprint # 
Instance details

Defined in Binary

Binary ByteString # 
Instance details

Defined in Binary

Binary UTCTime # 
Instance details

Defined in Binary

Binary DiffTime # 
Instance details

Defined in Binary

Binary Day # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Day -> IO () #

put :: BinHandle -> Day -> IO (Bin Day) #

get :: BinHandle -> IO Day #

Binary Serialized # 
Instance details

Defined in Binary

Binary Name #

Assumes that the Name is a non-binding one. See putIfaceTopBndr and getIfaceTopBndr for serializing binding Names. See UserData for the rationale for this distinction.

Instance details

Defined in Name

Methods

put_ :: BinHandle -> Name -> IO () #

put :: BinHandle -> Name -> IO (Bin Name) #

get :: BinHandle -> IO Name #

Binary OccName # 
Instance details

Defined in OccName

Binary FastString # 
Instance details

Defined in Binary

Binary ComponentId # 
Instance details

Defined in Module

Binary InstalledUnitId # 
Instance details

Defined in Module

Binary UnitId # 
Instance details

Defined in Module

Methods

put_ :: BinHandle -> UnitId -> IO () #

put :: BinHandle -> UnitId -> IO (Bin UnitId) #

get :: BinHandle -> IO UnitId #

Binary ModuleName # 
Instance details

Defined in Module

Binary Module # 
Instance details

Defined in Module

Methods

put_ :: BinHandle -> Module -> IO () #

put :: BinHandle -> Module -> IO (Bin Module) #

get :: BinHandle -> IO Module #

Binary SrcSpan # 
Instance details

Defined in Binary

Binary InlineSpec # 
Instance details

Defined in Binary

Binary InlinePragma # 
Instance details

Defined in Binary

Binary RuleMatchInfo # 
Instance details

Defined in Binary

Binary Activation # 
Instance details

Defined in Binary

Binary SourceText # 
Instance details

Defined in Binary

Binary TupleSort # 
Instance details

Defined in Binary

Binary OverlapMode # 
Instance details

Defined in Binary

Binary OverlapFlag # 
Instance details

Defined in Binary

Binary RecFlag # 
Instance details

Defined in Binary

Binary FixityDirection # 
Instance details

Defined in Binary

Binary Fixity # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Fixity -> IO () #

put :: BinHandle -> Fixity -> IO (Bin Fixity) #

get :: BinHandle -> IO Fixity #

Binary WarningTxt # 
Instance details

Defined in Binary

Binary StringLiteral # 
Instance details

Defined in Binary

Binary FunctionOrData # 
Instance details

Defined in Binary

Binary LeftOrRight # 
Instance details

Defined in Binary

Binary DefUnitId # 
Instance details

Defined in Module

Binary IndefUnitId # 
Instance details

Defined in Module

Binary CType # 
Instance details

Defined in ForeignCall

Methods

put_ :: BinHandle -> CType -> IO () #

put :: BinHandle -> CType -> IO (Bin CType) #

get :: BinHandle -> IO CType #

Binary Header # 
Instance details

Defined in ForeignCall

Methods

put_ :: BinHandle -> Header -> IO () #

put :: BinHandle -> Header -> IO (Bin Header) #

get :: BinHandle -> IO Header #

Binary CCallConv # 
Instance details

Defined in ForeignCall

Binary CCallTarget # 
Instance details

Defined in ForeignCall

Binary CCallSpec # 
Instance details

Defined in ForeignCall

Binary CExportSpec # 
Instance details

Defined in ForeignCall

Binary Safety # 
Instance details

Defined in ForeignCall

Methods

put_ :: BinHandle -> Safety -> IO () #

put :: BinHandle -> Safety -> IO (Bin Safety) #

get :: BinHandle -> IO Safety #

Binary ForeignCall # 
Instance details

Defined in ForeignCall

Binary HscSource # 
Instance details

Defined in DriverPhases

Binary NameSpace # 
Instance details

Defined in OccName

Binary AvailInfo # 
Instance details

Defined in Avail

Binary ArgFlag # 
Instance details

Defined in Var

Binary IfaceCoercion # 
Instance details

Defined in IfaceType

Binary IfaceTyLit # 
Instance details

Defined in IfaceType

Binary IfaceTyCon # 
Instance details

Defined in IfaceType

Binary IfaceType # 
Instance details

Defined in IfaceType

Binary IfaceTcArgs # 
Instance details

Defined in IfaceType

Binary IsCafCC # 
Instance details

Defined in CostCentre

Binary CostCentre # 
Instance details

Defined in CostCentre

Binary Role # 
Instance details

Defined in CoAxiom

Methods

put_ :: BinHandle -> Role -> IO () #

put :: BinHandle -> Role -> IO (Bin Role) #

get :: BinHandle -> IO Role #

Binary Injectivity # 
Instance details

Defined in TyCon

Binary TyConBndrVis # 
Instance details

Defined in TyCon

Binary IfaceUnivCoProv # 
Instance details

Defined in IfaceType

Binary IfaceTyConInfo # 
Instance details

Defined in IfaceType

Binary IfaceTyConSort # 
Instance details

Defined in IfaceType

Binary IsPromoted # 
Instance details

Defined in IfaceType

Binary IfaceOneShot # 
Instance details

Defined in IfaceType

Binary IfaceBndr # 
Instance details

Defined in IfaceType

Binary Literal # 
Instance details

Defined in Literal

Binary SrcUnpackedness # 
Instance details

Defined in DataCon

Binary SrcStrictness # 
Instance details

Defined in DataCon

Binary StrictSig # 
Instance details

Defined in Demand

Binary DmdType # 
Instance details

Defined in Demand

Binary CPRResult # 
Instance details

Defined in Demand

Binary DmdResult # 
Instance details

Defined in Demand

Binary Count # 
Instance details

Defined in Demand

Methods

put_ :: BinHandle -> Count -> IO () #

put :: BinHandle -> Count -> IO (Bin Count) #

get :: BinHandle -> IO Count #

Binary UseDmd # 
Instance details

Defined in Demand

Methods

put_ :: BinHandle -> UseDmd -> IO () #

put :: BinHandle -> UseDmd -> IO (Bin UseDmd) #

get :: BinHandle -> IO UseDmd #

Binary StrDmd # 
Instance details

Defined in Demand

Methods

put_ :: BinHandle -> StrDmd -> IO () #

put :: BinHandle -> StrDmd -> IO (Bin StrDmd) #

get :: BinHandle -> IO StrDmd #

Binary IsOrphan # 
Instance details

Defined in CoreSyn

Binary IfaceJoinInfo # 
Instance details

Defined in IfaceSyn

Binary IfaceLetBndr # 
Instance details

Defined in IfaceSyn

Binary IfaceBinding # 
Instance details

Defined in IfaceSyn

Binary IfaceConAlt # 
Instance details

Defined in IfaceSyn

Binary IfaceTickish # 
Instance details

Defined in IfaceSyn

Binary IfaceExpr # 
Instance details

Defined in IfaceSyn

Binary IfaceIdDetails # 
Instance details

Defined in IfaceSyn

Binary IfaceUnfolding # 
Instance details

Defined in IfaceSyn

Binary IfaceInfoItem # 
Instance details

Defined in IfaceSyn

Binary IfaceIdInfo # 
Instance details

Defined in IfaceSyn

Binary IfaceCompleteMatch # 
Instance details

Defined in IfaceSyn

Binary IfaceAnnotation # 
Instance details

Defined in IfaceSyn

Binary IfaceRule # 
Instance details

Defined in IfaceSyn

Binary IfaceFamInst # 
Instance details

Defined in IfaceSyn

Binary IfaceClsInst # 
Instance details

Defined in IfaceSyn

Binary IfaceSrcBang # 
Instance details

Defined in IfaceSyn

Binary IfaceBang # 
Instance details

Defined in IfaceSyn

Binary IfaceConDecl # 
Instance details

Defined in IfaceSyn

Binary IfaceConDecls # 
Instance details

Defined in IfaceSyn

Binary IfaceAxBranch # 
Instance details

Defined in IfaceSyn

Binary IfaceAT # 
Instance details

Defined in IfaceSyn

Binary IfaceClassOp # 
Instance details

Defined in IfaceSyn

Binary IfaceFamTyConFlav # 
Instance details

Defined in IfaceSyn

Binary IfaceTyConParent # 
Instance details

Defined in IfaceSyn

Binary IfaceDecl # 
Instance details

Defined in IfaceSyn

Binary IfaceTrustInfo # 
Instance details

Defined in HscTypes

Binary IfaceVectInfo # 
Instance details

Defined in HscTypes

Binary Usage # 
Instance details

Defined in HscTypes

Methods

put_ :: BinHandle -> Usage -> IO () #

put :: BinHandle -> Usage -> IO (Bin Usage) #

get :: BinHandle -> IO Usage #

Binary Dependencies # 
Instance details

Defined in HscTypes

Binary Warnings # 
Instance details

Defined in HscTypes

Binary ModIface # 
Instance details

Defined in HscTypes

Binary a => Binary [a] # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> [a] -> IO () #

put :: BinHandle -> [a] -> IO (Bin [a]) #

get :: BinHandle -> IO [a] #

Binary a => Binary (Maybe a) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Maybe a -> IO () #

put :: BinHandle -> Maybe a -> IO (Bin (Maybe a)) #

get :: BinHandle -> IO (Maybe a) #

Binary a => Binary (Ratio a) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Ratio a -> IO () #

put :: BinHandle -> Ratio a -> IO (Bin (Ratio a)) #

get :: BinHandle -> IO (Ratio a) #

Binary (DefMethSpec IfaceType) # 
Instance details

Defined in IfaceType

Binary a => Binary (BooleanFormula a) # 
Instance details

Defined in BooleanFormula

Binary a => Binary (FieldLbl a) # 
Instance details

Defined in FieldLabel

Methods

put_ :: BinHandle -> FieldLbl a -> IO () #

put :: BinHandle -> FieldLbl a -> IO (Bin (FieldLbl a)) #

get :: BinHandle -> IO (FieldLbl a) #

Binary name => Binary (AnnTarget name) # 
Instance details

Defined in Annotations

Methods

put_ :: BinHandle -> AnnTarget name -> IO () #

put :: BinHandle -> AnnTarget name -> IO (Bin (AnnTarget name)) #

get :: BinHandle -> IO (AnnTarget name) #

(Binary a, Binary b) => Binary (Either a b) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Either a b -> IO () #

put :: BinHandle -> Either a b -> IO (Bin (Either a b)) #

get :: BinHandle -> IO (Either a b) #

Typeable a => Binary (TypeRep a) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> TypeRep a -> IO () #

put :: BinHandle -> TypeRep a -> IO (Bin (TypeRep a)) #

get :: BinHandle -> IO (TypeRep a) #

(Binary a, Binary b) => Binary (a, b) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b) -> IO () #

put :: BinHandle -> (a, b) -> IO (Bin (a, b)) #

get :: BinHandle -> IO (a, b) #

Binary a => Binary (GenLocated SrcSpan a) # 
Instance details

Defined in Binary

Binary (Bin a) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> Bin a -> IO () #

put :: BinHandle -> Bin a -> IO (Bin (Bin a)) #

get :: BinHandle -> IO (Bin a) #

(Binary tv, Binary vis) => Binary (TyVarBndr tv vis) # 
Instance details

Defined in Var

Methods

put_ :: BinHandle -> TyVarBndr tv vis -> IO () #

put :: BinHandle -> TyVarBndr tv vis -> IO (Bin (TyVarBndr tv vis)) #

get :: BinHandle -> IO (TyVarBndr tv vis) #

(Binary a, Binary b, Binary c) => Binary (a, b, c) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b, c) -> IO () #

put :: BinHandle -> (a, b, c) -> IO (Bin (a, b, c)) #

get :: BinHandle -> IO (a, b, c) #

(Binary a, Binary b, Binary c, Binary d) => Binary (a, b, c, d) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b, c, d) -> IO () #

put :: BinHandle -> (a, b, c, d) -> IO (Bin (a, b, c, d)) #

get :: BinHandle -> IO (a, b, c, d) #

(Binary a, Binary b, Binary c, Binary d, Binary e) => Binary (a, b, c, d, e) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b, c, d, e) -> IO () #

put :: BinHandle -> (a, b, c, d, e) -> IO (Bin (a, b, c, d, e)) #

get :: BinHandle -> IO (a, b, c, d, e) #

(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f) => Binary (a, b, c, d, e, f) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b, c, d, e, f) -> IO () #

put :: BinHandle -> (a, b, c, d, e, f) -> IO (Bin (a, b, c, d, e, f)) #

get :: BinHandle -> IO (a, b, c, d, e, f) #

(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g) => Binary (a, b, c, d, e, f, g) # 
Instance details

Defined in Binary

Methods

put_ :: BinHandle -> (a, b, c, d, e, f, g) -> IO () #

put :: BinHandle -> (a, b, c, d, e, f, g) -> IO (Bin (a, b, c, d, e, f, g)) #

get :: BinHandle -> IO (a, b, c, d, e, f, g) #

seekBin :: BinHandle -> Bin a -> IO () #

seekBy :: BinHandle -> Int -> IO () #

castBin :: Bin a -> Bin b #

withBinBuffer :: BinHandle -> (ByteString -> IO a) -> IO a #

Get access to the underlying buffer.

It is quite important that no references to the ByteString leak out of the continuation lest terrible things happen.

putAt :: Binary a => BinHandle -> Bin a -> a -> IO () #

getAt :: Binary a => BinHandle -> Bin a -> IO a #

For writing instances

putByte :: BinHandle -> Word8 -> IO () #

Lazy Binary I/O

lazyGet :: Binary a => BinHandle -> IO a #

lazyPut :: Binary a => BinHandle -> a -> IO () #

User data

data UserData #

Information we keep around during interface file serialization/deserialization. Namely we keep the functions for serializing and deserializing Names and FastStrings. We do this because we actually use serialization in two distinct settings,

  • When serializing interface files themselves
  • When computing the fingerprint of an IfaceDecl (which we computing by hashing its Binary serialization)

These two settings have different needs while serializing Names:

  • Names in interface files are serialized via a symbol table (see Note [Symbol table representation of names] in BinIface).
  • During fingerprinting a binding Name is serialized as the OccName and a non-binding Name is serialized as the fingerprint of the thing they represent. See Note [Fingerprinting IfaceDecls] for further discussion.

Constructors

UserData 

Fields

newReadState #

Arguments

:: (BinHandle -> IO Name)

how to deserialize Names

-> (BinHandle -> IO FastString) 
-> UserData 

newWriteState #

Arguments

:: (BinHandle -> Name -> IO ())

how to serialize non-binding Names

-> (BinHandle -> Name -> IO ())

how to serialize binding Names

-> (BinHandle -> FastString -> IO ()) 
-> UserData