Safe Haskell	None
Language	Haskell2010

Data.Aeson.AutoType.Nested

Description

Simple interface for using AutoType inference in other code generators.

Simply takes a list of Aeson values, and returns a type description.

For this type description, we can use function to generate an entire new module.

Note that while we can put more code in the module, it is recommended to avoid multiple automatically generated types in order to avoid name conflicts.

Synopsis

defaultImportedModules :: [ModuleImport]
generateModuleImports :: [ModuleImport] -> Text
inferType :: Text -> [Value] -> DeclaredType
type CodeFragment = Text
type TypeName = Text
data DeclaredType = DeclaredType {
- typeCodeFragment :: CodeFragment
- typeName :: TypeName
- typeImportedModules :: [ImportedModule]
- typePackages :: [PackageName]
}

Documentation

defaultImportedModules :: [ModuleImport] Source #

List of modules imported for Autotyped declarations

generateModuleImports :: [ModuleImport] -> Text Source #

inferType :: Text -> [Value] -> DeclaredType Source #

Given intended type name, and a list of text fields with JSON, return either an error, or an EndpointResponse that allows to declare and use this type in generated module.

type CodeFragment = Text Source #

type TypeName = Text Source #

data DeclaredType Source #

Type declaration and its requirements Content to embed in an autogenerated module: * name of the type to reference * declarations to describe it * module imports necessary for declarations to work

Constructors

DeclaredType
Fields typeCodeFragment :: CodeFragment Code fragment to be inserted in generated module typeName :: TypeName Toplevel type name to refer to typeImportedModules :: [ImportedModule] List of clauses to add to imports list typePackages :: [PackageName] List of packages to add to generated package dependencies

Instances

Instances details

Eq DeclaredType Source #
Instance details Defined in Data.Aeson.AutoType.Nested Methods (==) :: DeclaredType -> DeclaredType -> Bool # (/=) :: DeclaredType -> DeclaredType -> Bool #
Show DeclaredType Source #
Instance details Defined in Data.Aeson.AutoType.Nested Methods showsPrec :: Int -> DeclaredType -> ShowS # show :: DeclaredType -> String # showList :: [DeclaredType] -> ShowS #
Generic DeclaredType Source #
Instance details Defined in Data.Aeson.AutoType.Nested Associated Types type Rep DeclaredType :: Type -> Type # Methods from :: DeclaredType -> Rep DeclaredType x # to :: Rep DeclaredType x -> DeclaredType #
Default DeclaredType Source #
Instance details Defined in Data.Aeson.AutoType.Nested Methods def :: DeclaredType
type Rep DeclaredType Source #
Instance details Defined in Data.Aeson.AutoType.Nested type Rep DeclaredType