| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Elm.Derive
Description
This module should be used to derive the Elm instance alongside the JSON ones. The prefered usage is to convert statements such as :
$(deriveJSON defaultOptions{fieldLabelModifier = drop 4, constructorTagModifier = map toLower} ''D)into:
$(deriveBoth defaultOptions{fieldLabelModifier = drop 4, constructorTagModifier = map toLower} ''D)Which will derive both the aeson and elm-bridge instances at the same
time.
Synopsis
- data Options
- data SumEncoding
- defaultOptions :: Options
- defaultOptionsDropLower :: Int -> Options
- deriveElmDef :: Options -> Name -> Q [Dec]
- deriveBoth :: Options -> Name -> Q [Dec]
Options
data SumEncoding #
Constructors
| TaggedObject | |
Fields | |
| UntaggedValue | |
| ObjectWithSingleField | |
| TwoElemArray | |
Instances
| Show SumEncoding | |
Defined in Data.Aeson.Types.Internal | |
| Eq SumEncoding | |
Defined in Data.Aeson.Types.Internal Methods (==) :: SumEncoding -> SumEncoding -> Bool Source # (/=) :: SumEncoding -> SumEncoding -> Bool Source # | |
defaultOptions :: Options Source #
Note that This default set of options is distinct from that in
the aeson package.
defaultOptionsDropLower :: Int -> Options Source #
This generates a default set of options. The parameter represents the number of characters that must be dropped from the Haskell field names. The first letter of the field is then converted to lowercase, ie:
data Foo = Foo { _fooBarQux :: Int }
$(deriveBoth (defaultOptionsDropLower 4) ''Foo)Will be encoded as:
{"barQux"=12}Template haskell functions
deriveElmDef :: Options -> Name -> Q [Dec] Source #
Just derive the elm-bridge definitions for generating the
serialization/deserialization code. It must be kept synchronized with
the Haskell code manually.
deriveBoth :: Options -> Name -> Q [Dec] Source #
Equivalent to running both deriveJSON and deriveElmDef with the
same options, so as to ensure the code on the Haskell and Elm size is
synchronized.