Elm.Ast

AST representing structure of Elm types. Haskell generic representation is converted to this AST which later is going to be pretty-printed.

Documentation

data ElmDefinition

Elm data type definition.

Constructors

DefRecord !ElmRecord

DefType !ElmType

DefPrim !ElmPrim

Instances

Show ElmDefinition

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmDefinition -> ShowS

show :: ElmDefinition -> String

showList :: [ElmDefinition] -> ShowS

data ElmRecord

AST for record type alias in Elm.

Constructors

ElmRecord

Fields

• elmRecordName :: !Text

  Name of the record

• elmRecordFields :: !(NonEmpty ElmRecordField)

  List of fields

• elmRecordIsNewtype :: !Bool

  True if Haskell type is a newtype

Instances

Show ElmRecord

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmRecord -> ShowS

show :: ElmRecord -> String

showList :: [ElmRecord] -> ShowS

data ElmType

AST for type in Elm.

Constructors

ElmType

Fields

• elmTypeName :: !Text

  Name of the data type

• elmTypeVars :: ![Text]

  List of type variables; currently only phantom variables

• elmTypeIsNewtype :: !Bool

  True if Haskell type is a newtype

• elmTypeConstructors :: !(NonEmpty ElmConstructor)

  List of constructors

Instances

Show ElmType

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmType -> ShowS

show :: ElmType -> String

showList :: [ElmType] -> ShowS

data ElmPrim

Primitive elm types; hardcoded by the language.

Constructors

ElmUnit

() type in elm

ElmNever

Never type in elm, analogous to Void in Haskell

ElmBool

Bool

ElmChar

Char

ElmInt

Int

ElmFloat

Float

ElmString

String

ElmTime

Posix in elm, UTCTime in Haskell

ElmValue

Json.Encode.Value in elm, Data.Aeson.Value in Haskell

ElmMaybe !TypeRef

Maybe T

ElmResult !TypeRef !TypeRef

Result A B in elm

ElmPair !TypeRef !TypeRef

(A, B) in elm

ElmTriple !TypeRef !TypeRef !TypeRef

(A, B, C) in elm

ElmList !TypeRef

List A in elm

ElmNonEmptyPair !TypeRef

NonEmpty A represented by (A, List A) in elm

Instances

Show ElmPrim

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmPrim -> ShowS

show :: ElmPrim -> String

showList :: [ElmPrim] -> ShowS

data ElmRecordField

Single field of record type alias.

Constructors

ElmRecordField

Fields

• elmRecordFieldType :: !TypeRef
• elmRecordFieldName :: !Text

Instances

Show ElmRecordField

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmRecordField -> ShowS

show :: ElmRecordField -> String

showList :: [ElmRecordField] -> ShowS

data ElmConstructor

Constructor of type.

Constructors

ElmConstructor

Fields

• elmConstructorName :: !Text

  Name of the constructor

• elmConstructorFields :: ![TypeRef]

  Fields of the constructor

Instances

Show ElmConstructor

Defined in Elm.Ast

Methods

showsPrec :: Int -> ElmConstructor -> ShowS

show :: ElmConstructor -> String

showList :: [ElmConstructor] -> ShowS

isEnum :: ElmType -> Bool

Checks if the given ElmType is Enum.

getConstructorNames :: ElmType -> [Text]

Gets the list of the constructor names.

newtype TypeName

Wrapper for name of the type.

Constructors

TypeName

Fields

• unTypeName :: Text

Instances

Show TypeName

Defined in Elm.Ast

Methods

showsPrec :: Int -> TypeName -> ShowS

show :: TypeName -> String

showList :: [TypeName] -> ShowS

data TypeRef

Reference to another existing type.

Constructors

RefPrim !ElmPrim

RefCustom !TypeName

Instances

Show TypeRef

Defined in Elm.Ast

Methods

showsPrec :: Int -> TypeRef -> ShowS

show :: TypeRef -> String

showList :: [TypeRef] -> ShowS

definitionToRef :: ElmDefinition -> TypeRef

Extracts reference to the existing data type type from some other type elm defintion.