Safe Haskell	Safe-Inferred
Language	GHC2021

Elmental.ElmStructure

Synopsis

data ElmMapping = ElmMapping {
- typeName :: TypeName
- moduleName :: Maybe ModuleName
- encoderLocation :: Maybe SymbolLocation
- decoderLocation :: Maybe SymbolLocation
- args :: [ElmMapping]
- isTypeAlias :: Bool
- urlPiece :: Maybe SymbolLocation
- queryParam :: Maybe SymbolLocation
}
type ModuleName = Text
type SymbolName = Text
type TypeName = Text
type ConstructorName = Text
type FieldName = Text
type VarName = Text
data SymbolLocation = SymbolLocation {
- symbolName :: SymbolName
- symbolModuleName :: ModuleName
}
data TyCon
- = TyMapping ElmMapping
- | TyVar VarName
data TyRef = TyRef {
- tyCon :: TyCon
- tyArgs :: [TyRef]
}
data DatatypeStructure a = DatatypeStructure {
- mapping :: ElmMapping
- nParams :: Integer
- constructors :: [Constructor]
}
type ElmField = (Maybe FieldName, TyRef)
data Constructor = Constructor {
- constructorName :: ConstructorName
- constructorFields :: [ElmField]
}

Documentation

data ElmMapping Source #

Contains the mapping of Haskell type constructor to an Elm type constructor, and potentially the location of its encoder / decoder.

Constructors

ElmMapping

Fields

typeName :: TypeName
Name of the corresponding Elm datatype.
moduleName :: Maybe ModuleName
Name of the module this type should be imported from / generated in.
Can be set to Nothing for core Elm types (List, Bool, String, ...) which don't require explicit imports.
encoderLocation :: Maybe SymbolLocation
Location of the encoder for this type.
Must be set if you want to generate it, or to generate encoders depending on it.
decoderLocation :: Maybe SymbolLocation
Location of the decoder for this type.
Must be set if you want to generate it, or to generate encoders depending on it.
args :: [ElmMapping]
Arguments supplied to the type constructor.
isTypeAlias :: Bool
Indicates whether the generated Elm datataype should be a type alias
urlPiece :: Maybe SymbolLocation
Location of the URL piece builder / parser for this type.
queryParam :: Maybe SymbolLocation
Location of the query param builder / parser for this type.

Instances

Instances details

Show ElmMapping Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> ElmMapping -> ShowS # show :: ElmMapping -> String # showList :: [ElmMapping] -> ShowS #
Eq ElmMapping Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: ElmMapping -> ElmMapping -> Bool # (/=) :: ElmMapping -> ElmMapping -> Bool #
Ord ElmMapping Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: ElmMapping -> ElmMapping -> Ordering # (<) :: ElmMapping -> ElmMapping -> Bool # (<=) :: ElmMapping -> ElmMapping -> Bool # (>) :: ElmMapping -> ElmMapping -> Bool # (>=) :: ElmMapping -> ElmMapping -> Bool # max :: ElmMapping -> ElmMapping -> ElmMapping # min :: ElmMapping -> ElmMapping -> ElmMapping #

type ModuleName = Text Source #

type SymbolName = Text Source #

type TypeName = Text Source #

type ConstructorName = Text Source #

type FieldName = Text Source #

type VarName = Text Source #

data SymbolLocation Source #

Location of an Elm value (symbol / module name).

Constructors

SymbolLocation
Fields symbolName :: SymbolName symbolModuleName :: ModuleName

Instances

Instances details

Show SymbolLocation Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> SymbolLocation -> ShowS # show :: SymbolLocation -> String # showList :: [SymbolLocation] -> ShowS #
Eq SymbolLocation Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: SymbolLocation -> SymbolLocation -> Bool # (/=) :: SymbolLocation -> SymbolLocation -> Bool #
Ord SymbolLocation Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: SymbolLocation -> SymbolLocation -> Ordering # (<) :: SymbolLocation -> SymbolLocation -> Bool # (<=) :: SymbolLocation -> SymbolLocation -> Bool # (>) :: SymbolLocation -> SymbolLocation -> Bool # (>=) :: SymbolLocation -> SymbolLocation -> Bool # max :: SymbolLocation -> SymbolLocation -> SymbolLocation # min :: SymbolLocation -> SymbolLocation -> SymbolLocation #

data TyCon Source #

Constructors

TyMapping ElmMapping
TyVar VarName

Instances

Instances details

Show TyCon Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> TyCon -> ShowS # show :: TyCon -> String # showList :: [TyCon] -> ShowS #
Eq TyCon Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: TyCon -> TyCon -> Bool # (/=) :: TyCon -> TyCon -> Bool #
Ord TyCon Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: TyCon -> TyCon -> Ordering # (<) :: TyCon -> TyCon -> Bool # (<=) :: TyCon -> TyCon -> Bool # (>) :: TyCon -> TyCon -> Bool # (>=) :: TyCon -> TyCon -> Bool # max :: TyCon -> TyCon -> TyCon # min :: TyCon -> TyCon -> TyCon #

data TyRef Source #

Constructors

TyRef
Fields tyCon :: TyCon tyArgs :: [TyRef]

Instances

Instances details

Show TyRef Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> TyRef -> ShowS # show :: TyRef -> String # showList :: [TyRef] -> ShowS #
Eq TyRef Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: TyRef -> TyRef -> Bool # (/=) :: TyRef -> TyRef -> Bool #
Ord TyRef Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: TyRef -> TyRef -> Ordering # (<) :: TyRef -> TyRef -> Bool # (<=) :: TyRef -> TyRef -> Bool # (>) :: TyRef -> TyRef -> Bool # (>=) :: TyRef -> TyRef -> Bool # max :: TyRef -> TyRef -> TyRef # min :: TyRef -> TyRef -> TyRef #

data DatatypeStructure a Source #

Constructors

DatatypeStructure
Fields mapping :: ElmMapping nParams :: Integer constructors :: [Constructor]

Instances

Instances details

Show (DatatypeStructure a) Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> DatatypeStructure a -> ShowS # show :: DatatypeStructure a -> String # showList :: [DatatypeStructure a] -> ShowS #
Eq (DatatypeStructure a) Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: DatatypeStructure a -> DatatypeStructure a -> Bool # (/=) :: DatatypeStructure a -> DatatypeStructure a -> Bool #
Ord (DatatypeStructure a) Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: DatatypeStructure a -> DatatypeStructure a -> Ordering # (<) :: DatatypeStructure a -> DatatypeStructure a -> Bool # (<=) :: DatatypeStructure a -> DatatypeStructure a -> Bool # (>) :: DatatypeStructure a -> DatatypeStructure a -> Bool # (>=) :: DatatypeStructure a -> DatatypeStructure a -> Bool # max :: DatatypeStructure a -> DatatypeStructure a -> DatatypeStructure a # min :: DatatypeStructure a -> DatatypeStructure a -> DatatypeStructure a #

type ElmField = (Maybe FieldName, TyRef) Source #

data Constructor Source #

Constructors

Constructor
Fields constructorName :: ConstructorName constructorFields :: [ElmField]

Instances

Instances details

Show Constructor Source #
Instance details Defined in Elmental.ElmStructure Methods showsPrec :: Int -> Constructor -> ShowS # show :: Constructor -> String # showList :: [Constructor] -> ShowS #
Eq Constructor Source #
Instance details Defined in Elmental.ElmStructure Methods (==) :: Constructor -> Constructor -> Bool # (/=) :: Constructor -> Constructor -> Bool #
Ord Constructor Source #
Instance details Defined in Elmental.ElmStructure Methods compare :: Constructor -> Constructor -> Ordering # (<) :: Constructor -> Constructor -> Bool # (<=) :: Constructor -> Constructor -> Bool # (>) :: Constructor -> Constructor -> Bool # (>=) :: Constructor -> Constructor -> Bool # max :: Constructor -> Constructor -> Constructor # min :: Constructor -> Constructor -> Constructor #