ghc-8.2.1: The GHC API

Safe HaskellNone
LanguageHaskell2010

Binary

Contents

Synopsis

Documentation

data Bin a Source #

Instances

Bounded (Bin k a) # 

Methods

minBound :: Bin k a Source #

maxBound :: Bin k a Source #

Eq (Bin k a) # 

Methods

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

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

Ord (Bin k a) # 

Methods

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

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

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

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

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

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

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

Show (Bin k a) # 

Methods

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

show :: Bin k a -> String Source #

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

Binary (Bin k a) # 

Methods

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

put :: BinHandle -> Bin k a -> IO (Bin * (Bin k a)) Source #

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

class Binary a where Source #

Minimal complete definition

get

Methods

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

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

get :: BinHandle -> IO a Source #

Instances

Binary Bool # 
Binary Char # 
Binary Int # 

Methods

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

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

get :: BinHandle -> IO Int Source #

Binary Int8 # 
Binary Int16 # 
Binary Int32 # 
Binary Int64 # 
Binary Integer # 
Binary Word8 # 
Binary Word16 # 
Binary Word32 # 
Binary Word64 # 
Binary RuntimeRep # 
Binary VecCount # 
Binary VecElem # 
Binary SomeTypeRep # 
Binary () # 

Methods

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

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

get :: BinHandle -> IO () Source #

Binary TyCon # 
Binary KindRep # 
Binary TypeLitSort # 
Binary Fingerprint # 
Binary ByteString # 
Binary UTCTime # 
Binary DiffTime # 
Binary Day # 

Methods

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

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

get :: BinHandle -> IO Day Source #

Binary Serialized # 
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.

Binary OccName # 
Binary FastString # 
Binary ComponentId # 
Binary InstalledUnitId # 
Binary UnitId # 
Binary ModuleName # 
Binary Module # 
Binary SrcSpan # 
Binary InlineSpec # 
Binary InlinePragma # 
Binary RuleMatchInfo # 
Binary Activation # 
Binary SourceText # 
Binary TupleSort # 
Binary OverlapMode # 
Binary OverlapFlag # 
Binary RecFlag # 
Binary FixityDirection # 
Binary Fixity # 
Binary WarningTxt # 
Binary StringLiteral # 
Binary FunctionOrData # 
Binary LeftOrRight # 
Binary DefUnitId # 
Binary IndefUnitId # 
Binary CType # 
Binary Header # 
Binary CCallConv # 
Binary CCallTarget # 
Binary CCallSpec # 
Binary CExportSpec # 
Binary Safety # 
Binary ForeignCall # 
Binary HscSource # 
Binary NameSpace # 
Binary AvailInfo # 
Binary ArgFlag # 
Binary IsCafCC # 
Binary CostCentre # 
Binary Role # 
Binary Injectivity # 
Binary TyConBndrVis # 
Binary IfaceTcArgs # 
Binary IfaceCoercion # 
Binary IfaceTyLit # 
Binary IfaceTyCon # 
Binary IfaceType # 
Binary IfaceUnivCoProv # 
Binary IfaceTyConInfo # 
Binary IfaceTyConSort # 
Binary IsPromoted # 
Binary IfaceOneShot # 
Binary IfaceBndr # 
Binary Literal # 
Binary SrcUnpackedness # 
Binary SrcStrictness # 
Binary StrictSig # 
Binary DmdType # 
Binary CPRResult # 
Binary DmdResult # 
Binary Count # 
Binary UseDmd # 
Binary StrDmd # 
Binary IsOrphan # 
Binary IfaceJoinInfo # 
Binary IfaceLetBndr # 
Binary IfaceBinding # 
Binary IfaceConAlt # 
Binary IfaceTickish # 
Binary IfaceExpr # 
Binary IfaceIdDetails # 
Binary IfaceUnfolding # 
Binary IfaceInfoItem # 
Binary IfaceIdInfo # 
Binary IfaceCompleteMatch # 
Binary IfaceAnnotation # 
Binary IfaceRule # 
Binary IfaceFamInst # 
Binary IfaceClsInst # 
Binary IfaceSrcBang # 
Binary IfaceBang # 
Binary IfaceConDecl # 
Binary IfaceConDecls # 
Binary IfaceAxBranch # 
Binary IfaceAT # 
Binary IfaceClassOp # 
Binary IfaceFamTyConFlav # 
Binary IfaceTyConParent # 
Binary IfaceDecl # 
Binary IfaceTrustInfo # 
Binary IfaceVectInfo # 
Binary Usage # 
Binary Dependencies # 
Binary Warnings # 
Binary ModIface # 
Binary a => Binary [a] # 

Methods

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

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

get :: BinHandle -> IO [a] Source #

Binary a => Binary (Maybe a) # 

Methods

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

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

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

Binary a => Binary (Ratio a) # 

Methods

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

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

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

Binary (DefMethSpec IfaceType) # 
Binary a => Binary (BooleanFormula a) # 
Binary a => Binary (FieldLbl a) # 
Binary name => Binary (AnnTarget name) # 

Methods

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

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

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

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

Methods

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

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

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

Typeable k a => Binary (TypeRep k a) # 

Methods

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

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

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

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

Methods

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

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

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

Binary a => Binary (GenLocated SrcSpan a) # 
Binary (Bin k a) # 

Methods

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

put :: BinHandle -> Bin k a -> IO (Bin * (Bin k a)) Source #

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

Methods

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

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

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

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

castBin :: Bin a -> Bin b Source #

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

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 () Source #

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

For writing instances

Lazy Binary I/O

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

User data

data UserData Source #

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 Source #

Arguments

:: (BinHandle -> IO Name)

how to deserialize Names

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

newWriteState Source #

Arguments

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

how to serialize non-binding Names

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

how to serialize binding Names

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