Language.PureScript.Bridge.SumType

Documentation

data SumType (lang :: Language)

Generic representation of your Haskell types.

Constructors

SumType (TypeInfo lang) [DataConstructor lang] [Instance]

Instances

Show (SumType lang)

Defined in Language.PureScript.Bridge.SumType

Methods

showsPrec :: Int -> SumType lang -> ShowS

show :: SumType lang -> String

showList :: [SumType lang] -> ShowS

Eq (SumType lang)

Defined in Language.PureScript.Bridge.SumType

Methods

(==) :: SumType lang -> SumType lang -> Bool

(/=) :: SumType lang -> SumType lang -> Bool

mkSumType :: forall t. (Generic t, Typeable t, GDataConstructor (Rep t)) => Proxy t -> SumType 'Haskell

Create a representation of your sum (and product) types, for doing type translations and writing it out to your PureScript modules. In order to get the type information we use a dummy variable of type Proxy (YourType).

equal :: Eq a => Proxy a -> SumType t -> SumType t

Ensure that an Instance instance is generated for your type.

order :: Ord a => Proxy a -> SumType t -> SumType t

Ensure that both Instance and Instance instances are generated for your type.

data DataConstructor (lang :: Language)

Constructors

DataConstructor

Fields

• _sigConstructor :: !Text

  e.g. Left/Right for Either

• _sigValues :: !(Either [TypeInfo lang] [RecordEntry lang])

Instances

Show (DataConstructor lang)

Defined in Language.PureScript.Bridge.SumType

Methods

showsPrec :: Int -> DataConstructor lang -> ShowS

show :: DataConstructor lang -> String

showList :: [DataConstructor lang] -> ShowS

Eq (DataConstructor lang)

Defined in Language.PureScript.Bridge.SumType

Methods

(==) :: DataConstructor lang -> DataConstructor lang -> Bool

(/=) :: DataConstructor lang -> DataConstructor lang -> Bool

data RecordEntry (lang :: Language)

Constructors

RecordEntry

Fields

• _recLabel :: !Text

  e.g. runState for State

• _recValue :: !(TypeInfo lang)

Instances

Show (RecordEntry lang)

Defined in Language.PureScript.Bridge.SumType

Methods

showsPrec :: Int -> RecordEntry lang -> ShowS

show :: RecordEntry lang -> String

showList :: [RecordEntry lang] -> ShowS

Eq (RecordEntry lang)

Defined in Language.PureScript.Bridge.SumType

Methods

(==) :: RecordEntry lang -> RecordEntry lang -> Bool

(/=) :: RecordEntry lang -> RecordEntry lang -> Bool

data Instance

Purescript typeclass instances that can be generated for your Haskell types.

Constructors

Encode

EncodeJson

Decode

DecodeJson

Generic

Newtype

Eq

Ord

Instances

Show Instance

Defined in Language.PureScript.Bridge.SumType

Methods

showsPrec :: Int -> Instance -> ShowS

show :: Instance -> String

showList :: [Instance] -> ShowS

Eq Instance

Defined in Language.PureScript.Bridge.SumType

Methods

(==) :: Instance -> Instance -> Bool

(/=) :: Instance -> Instance -> Bool

nootype :: [DataConstructor lang] -> Maybe Instance

The Purescript typeclass Newtype might be derivable if the original Haskell type was a simple type wrapper.

getUsedTypes :: SumType lang -> Set (TypeInfo lang)

Get all used types in a sum type.

This includes all types found at the right hand side of a sum type definition, not the type parameters of the sum type itself

constructorToTypes :: DataConstructor lang -> Set (TypeInfo lang) -> Set (TypeInfo lang)

sigConstructor :: forall lang. Lens' (DataConstructor lang) Text

sigValues :: forall lang lang. Lens (DataConstructor lang) (DataConstructor lang) (Either [TypeInfo lang] [RecordEntry lang]) (Either [TypeInfo lang] [RecordEntry lang])

sumTypeInfo :: Functor f => (TypeInfo lang -> f (TypeInfo lang)) -> SumType lang -> f (SumType lang)

TypInfo lens for SumType.

sumTypeConstructors :: Functor f => ([DataConstructor lang] -> f [DataConstructor lang]) -> SumType lang -> f (SumType lang)

DataConstructor lens for SumType.

recLabel :: forall lang. Lens' (RecordEntry lang) Text

recValue :: forall lang lang. Lens (RecordEntry lang) (RecordEntry lang) (TypeInfo lang) (TypeInfo lang)