Data.Aeson.Schema.CodeGen

Documentation

data Declaration

A top-level declaration.

Constructors

Declaration Dec (Maybe Text)

Optional textual declaration. This can be used for information (e.g. inline comments) that are not representable in TH.

Comment Text

Comment text

Instances

Eq Declaration

Data Declaration

Show Declaration

Typeable * Declaration

MonadWriter Code (CodeGenM s)

type Code = [Declaration]

 Haskell code (without module declaration and imports)

generate :: Graph Schema Text -> Q (Code, Map Text Name)

 Generate a generalized representation of the code in a Haskell module

generateTH

Arguments

:: Graph Schema Text

Set of schemas

-> Q ([Dec], Map Text Name)

Generated code and mapping from schema identifiers to type names

 Generate data-types and FromJSON instances for all schemas

generateModule

Arguments

:: Text

Name of the generated module

-> Graph Schema Text

Set of schemas

-> Q (Text, Map Text Name)

Module code and mapping from schema identifiers to type names

 Generated a self-contained module that parses and validates values of a set of given schemas.