Data.API.Tools.Datatypes

Documentation

datatypesTool :: APITool

Tool to generate datatypes and type synonyms corresponding to an API

datatypesTool' :: (APINode -> [Name]) -> APITool

Tool to generate datatypes and type synonyms corresponding to an API, where the function specifies the derived classes for each datatype.

defaultDerivedClasses :: APINode -> [Name]

Default names of classes for which to derive instances, depending on the type of API node.

type_nm :: APINode -> Name

Name of the type corresponding to the API node, e.g. JobId

rep_type_nm :: APINode -> Name

Name of the representation type corresponding to the API node, which differs from the type_nm only if custom conversion functions are specified. This is also the name of the sole constructor for newtypes and records.

nodeT :: APINode -> TypeQ

The type corresponding to an API node

nodeRepT :: APINode -> TypeQ

The representation type corresponding to an API node

nodeConE :: APINode -> ExpQ

The constructor for a record API node

nodeNewtypeConE :: ToolSettings -> APINode -> SpecNewtype -> ExpQ

The constructor for a newtype, which might be renamed

nodeFieldE :: APINode -> FieldName -> ExpQ

A record field in an API node, as an expression

nodeFieldP :: APINode -> FieldName -> PatQ

A record field in an API node, as a pattern

nodeAltConE :: APINode -> FieldName -> ExpQ

A prefixed constructor for a union or enum, as an expression

nodeAltConP :: APINode -> FieldName -> [PatQ] -> PatQ

A prefixed constructor for a union or enum, as a pattern

newtypeProjectionE :: APINode -> ExpQ

The projection function from a newtype API node, as an epxression