Language.Haskell.To.Elm

Classes

class HasElmType a where

Represents that the corresponding Elm type for the Haskell type a is elmType @a.

Minimal complete definition

elmType | elmDefinition

Methods

elmType :: Type v

elmType :: Type v

elmDefinition :: Maybe Definition

When Just, this represents that we can generate the definition for the Elm type that corresponds to a using elmDefinition @a.

See deriveElmTypeDefinition for a way to automatically derive elmDefinition.

When Nothing, it means that the type is an already existing Elm type that does not need to be generated.

Instances

HasElmType Bool

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType Char

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType Double

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType Int

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType Text

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType a => HasElmType [a]

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

HasElmType a => HasElmType (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

(HasElmType a, HasElmType b) => HasElmType (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

elmDefinition :: Maybe Definition

class HasElmType a => HasElmDecoder value a where

Represents that the Elm type that corresponds to a has a decoder from value, namely elmDecoder @value @a.

Minimal complete definition

elmDecoder | elmDecoderDefinition

Methods

elmDecoder :: Expression v

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

When Just, this represents that we can generate the Elm decoder definition from value for the Elm type that corresponds to a.

See deriveElmJSONDecoder for a way to automatically derive elmDecoderDefinition when value = Value.

Instances

HasElmDecoder Text Text

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value Bool

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value Char

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value Double

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value Int

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value Text

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value a => HasElmDecoder Value [a]

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

HasElmDecoder Value a => HasElmDecoder Value (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

(HasElmDecoder Value a, HasElmDecoder Value b) => HasElmDecoder Value (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

elmDecoderDefinition :: Maybe Definition

class HasElmType a => HasElmEncoder value a where

Represents that the Elm type that corresponds to a has an encoder into value, namely elmEncoder @value @a.

This class has a default instance for types that satisfy HasElmEncoderDefinition, which refers to the name of that definition.

Minimal complete definition

elmEncoder | elmEncoderDefinition

Methods

elmEncoder :: Expression v

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

When Just, this represents that we can generate the Elm encoder definition into value for the Elm type that corresponds to a.

See deriveElmJSONEncoder for a way to automatically derive elmEncoderDefinition when value = Value.

Instances

HasElmEncoder Text Char

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Text Double

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Text Int

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Text Text

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value Bool

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value Char

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value Double

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value Int

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value Text

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value a => HasElmEncoder Value [a]

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder Value a => HasElmEncoder Value (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

(HasElmEncoder Value a, HasElmEncoder Value b) => HasElmEncoder Value (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

HasElmEncoder a b => HasElmEncoder (Maybe a) (Maybe b)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

elmEncoderDefinition :: Maybe Definition

Derivers

newtype Options

Elm code generation options

Constructors

Options

Fields

• fieldLabelModifier :: String -> String

  Use this function to go from Haskell record field name to Elm record field name.

defaultOptions :: Options

deriveElmTypeDefinition :: forall a. (HasDatatypeInfo a, All2 HasElmType (Code a)) => Options -> Qualified -> Definition

Automatically create an Elm definition given a Haskell type.

This is suitable for use as the elmDefinition in a HasElmType instance:

instance HasElmType MyType where
  elmDefinition =
    Just $ deriveElmTypeDefinition @MyType defaultOptions "Api.MyType.MyType"

deriveElmJSONDecoder :: forall a. (HasDatatypeInfo a, HasElmType a, All2 (HasElmDecoder Value) (Code a)) => Options -> Options -> Qualified -> Definition

Automatically create an Elm JSON decoder definition given a Haskell type.

This is suitable for use as the elmDecoderDefinition in a HasElmDecoder Value instance:

instance HasElmDecoder Value MyType where
  elmDecoderDefinition =
    Just $ deriveElmJSONDecoder @MyType defaultOptions defaultOptions "Api.MyType.decoder"

Uses the given Options to match the JSON format of derived FromJSON and ToJSON instances.

deriveElmJSONEncoder :: forall a. (HasDatatypeInfo a, HasElmType a, All2 (HasElmEncoder Value) (Code a)) => Options -> Options -> Qualified -> Definition

Automatically create an Elm JSON encoder definition given a Haskell type.

This is suitable for use as the elmEncoderDefinition in a 'HasElmEncoder Value instance:

instance HasElmEncoder Value MyType where
  elmEncoderDefinition =
    Just $ deriveElmJSONEncoder @MyType defaultOptions defaultOptions "Api.MyType.encoder"

Uses the given Options to match the JSON format of derived FromJSON and ToJSON instances.

jsonDefinitions :: forall t. (HasElmEncoder Value t, HasElmDecoder Value t) => [Definition]

A shorthand for a list of the type definitions for jsonDefinitions @MyType is a shorthand for creating a list of its elmDefinition, elmEncoderDefinition @Value, and elmDecoderDefinition @Value.