| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Generics.SOP.Metadata
Contents
Description
Metadata about what a datatype looks like
In generics-sop, the metadata is completely independent of the main
universe. Many generic functions will use this metadata, but other don't,
and yet others might need completely different metadata.
This module defines a datatype to represent standard metadata, i.e., names of the datatype, its constructors, and possibly its record selectors. Metadata descriptions are in general GADTs indexed by the code of the datatype they're associated with, so matching on the metadata will reveal information about the shape of the datatype.
- data DatatypeInfo :: [[*]] -> * where
- ADT :: ModuleName -> DatatypeName -> NP ConstructorInfo xss -> DatatypeInfo xss
- Newtype :: ModuleName -> DatatypeName -> ConstructorInfo `[x]` -> DatatypeInfo `[`[x]`]`
- data ConstructorInfo :: [*] -> * where
- Constructor :: SingI xs => ConstructorName -> ConstructorInfo xs
- Infix :: ConstructorName -> Associativity -> Fixity -> ConstructorInfo `[x, y]`
- Record :: SingI xs => ConstructorName -> NP FieldInfo xs -> ConstructorInfo xs
- data FieldInfo :: * -> * where
- type DatatypeName = String
- type ModuleName = String
- type ConstructorName = String
- type FieldName = String
- type Fixity = Int
- data Associativity :: *
Documentation
data DatatypeInfo :: [[*]] -> * where Source
Metadata for a datatype.
A value of type DatatypeInfo cCode c
The constructor indicates whether the datatype has been declared using newtype
or not.
Constructors
| ADT :: ModuleName -> DatatypeName -> NP ConstructorInfo xss -> DatatypeInfo xss | |
| Newtype :: ModuleName -> DatatypeName -> ConstructorInfo `[x]` -> DatatypeInfo `[`[x]`]` |
Instances
| All * Eq (Map * [*] ConstructorInfo xs) => Eq (DatatypeInfo xs) | |
| (All * Eq (Map * [*] ConstructorInfo xs), All * Ord (Map * [*] ConstructorInfo xs)) => Ord (DatatypeInfo xs) | |
| All * Show (Map * [*] ConstructorInfo xs) => Show (DatatypeInfo xs) |
data ConstructorInfo :: [*] -> * where Source
Metadata for a single constructors.
This is indexed by the product structure of the constructor components.
Constructors
| Constructor :: SingI xs => ConstructorName -> ConstructorInfo xs | |
| Infix :: ConstructorName -> Associativity -> Fixity -> ConstructorInfo `[x, y]` | |
| Record :: SingI xs => ConstructorName -> NP FieldInfo xs -> ConstructorInfo xs |
data FieldInfo :: * -> * where Source
For records, this functor maps the component to its selector name.
type DatatypeName = String Source
The name of a datatype.
type ModuleName = String Source
The name of a module.
type ConstructorName = String Source
The name of a data constructor.
re-exports
data Associativity :: *
Datatype to represent the associativity of a constructor
Constructors
| LeftAssociative | |
| RightAssociative | |
| NotAssociative |
Instances
| Eq Associativity | |
| Ord Associativity | |
| Read Associativity | |
| Show Associativity | |
| Generic Associativity | |
| type Rep Associativity = D1 D1Associativity ((:+:) (C1 C1_0Associativity U1) ((:+:) (C1 C1_1Associativity U1) (C1 C1_2Associativity U1))) |