Generic.Data.Internal.Meta

Type metadata accessors

Type names, constructor names...

Documentation

gdatatypeName :: forall a. (Generic a, GDatatype (Rep a)) => String

Name of the first data constructor in a type as a string.

gdatatypeName @(Maybe AnyType) = "Maybe"

gmoduleName :: forall a. (Generic a, GDatatype (Rep a)) => String

Name of the module where the first type constructor is defined.

gmoduleName @(Maybe AnyType) = "GHC.Base"

gpackageName :: forall a. (Generic a, GDatatype (Rep a)) => String

Name of the package where the first type constructor is defined.

gpackageName @(Maybe AnyType) = "base"

gisNewtype :: forall a. (Generic a, GDatatype (Rep a)) => Bool

True if the first type constructor is a newtype.

fromDatatype :: forall d r. Datatype d => (M1 D d Proxy () -> r) -> r

class GDatatype f where

Generic representations that contain datatype metadata.

Minimal complete definition

gDatatypeName, gModuleName, gPackageName, gIsNewtype

Methods

gDatatypeName :: String

gModuleName :: String

gPackageName :: String

gIsNewtype :: Bool

Instances

Datatype Meta d => GDatatype (k -> *) (M1 k D d f)

Methods

gDatatypeName :: String

gModuleName :: String

gPackageName :: String

gIsNewtype :: Bool

gconName :: forall a. Constructors a => a -> String

Name of the first constructor in a value.

gconName (Just 0) = "Just"

gconFixity :: forall a. Constructors a => a -> Fixity

The fixity of the first constructor.

gconFixity (Just 0) = Prefix
gconFixity ([] :*: id) = Infix RightAssociative 6

gconIsRecord :: forall a. Constructors a => a -> Bool

True if the constructor is a record.

gconIsRecord (Just 0) = False
gconIsRecord (Sum 0) = True
-- newtype Sum a = Sum { getSum :: a }

gconNum :: forall a. Constructors a => Int

Number of constructors.

gconNum @(Maybe AnyType) = 2

gconIndex :: forall a. Constructors a => a -> Int

Index of a constructor.

gconIndex Nothing = 0
gconIndex (Just "test") = 1

newtype ConId a

An opaque identifier for a constructor.

Constructors

ConId Int

Instances

Eq (ConId k a)

Methods

(==) :: ConId k a -> ConId k a -> Bool

(/=) :: ConId k a -> ConId k a -> Bool

Ord (ConId k a)

Methods

compare :: ConId k a -> ConId k a -> Ordering

(<) :: ConId k a -> ConId k a -> Bool

(<=) :: ConId k a -> ConId k a -> Bool

(>) :: ConId k a -> ConId k a -> Bool

(>=) :: ConId k a -> ConId k a -> Bool

max :: ConId k a -> ConId k a -> ConId k a

min :: ConId k a -> ConId k a -> ConId k a

conId :: forall a. Constructors a => a -> ConId a

Identifier of a constructor.

conIdToInt :: forall a. ConId a -> Int

Index of a constructor, given its identifier. See also gconIndex.

conIdToString :: forall a. Constructors a => ConId a -> String

Name of a constructor. See also gconName.

conIdEnum :: forall a. Constructors a => [ConId a]

All constructor identifiers.

gconNum @a = length (conIdEnum @a)

conIdMin :: forall a. Constructors a => ConId a

This must not be called on an empty type.

conIdMax :: forall a. Constructors a => ConId a

This must not be called on an empty type.

class (Generic a, GConstructors (Rep a)) => Constructors a

Constraint synonym for Generic and GConstructor.

Instances

(Generic a, GConstructors * (Rep a)) => Constructors a

newtype GConId r

Constructors

GConId Int

Instances

Eq (GConId k r)

Methods

(==) :: GConId k r -> GConId k r -> Bool

(/=) :: GConId k r -> GConId k r -> Bool

Ord (GConId k r)

Methods

compare :: GConId k r -> GConId k r -> Ordering

(<) :: GConId k r -> GConId k r -> Bool

(<=) :: GConId k r -> GConId k r -> Bool

(>) :: GConId k r -> GConId k r -> Bool

(>=) :: GConId k r -> GConId k r -> Bool

max :: GConId k r -> GConId k r -> GConId k r

min :: GConId k r -> GConId k r -> GConId k r

gConIdToInt :: GConId r -> Int

toConId :: forall a. Generic a => GConId (Rep a) -> ConId a

fromConId :: forall a. Generic a => ConId a -> GConId (Rep a)

reGConId :: GConId r -> GConId s

gConIdMin :: forall r. GConstructors r => GConId r

gConIdMax :: forall r. GConstructors r => GConId r

class GConstructors r where

Generic representations that contain constructor metadata.

Minimal complete definition

gConIdToString, gConId, gConNum, gConFixity, gConIsRecord

Methods

gConIdToString :: GConId r -> String

gConId :: r p -> GConId r

gConNum :: Int

gConFixity :: r p -> Fixity

gConIsRecord :: r p -> Bool

Instances

(GConstructors k f, GConstructors k g) => GConstructors k ((:+:) k f g)

Methods

gConIdToString :: GConId ((k :+: f) g -> *) r -> String

gConId :: r p -> GConId ((k :+: f) g -> *) r

gConNum :: Int

gConFixity :: r p -> Fixity

gConIsRecord :: r p -> Bool

Constructor Meta c => GConstructors k (M1 k C c f)

Methods

gConIdToString :: GConId (M1 k C c f -> *) r -> String

gConId :: r p -> GConId (M1 k C c f -> *) r

gConNum :: Int

gConFixity :: r p -> Fixity

gConIsRecord :: r p -> Bool

GConstructors k f => GConstructors k (M1 k D c f)

Methods

gConIdToString :: GConId (M1 k D c f -> *) r -> String

gConId :: r p -> GConId (M1 k D c f -> *) r

gConNum :: Int

gConFixity :: r p -> Fixity

gConIsRecord :: r p -> Bool

Type families

type family MetaOf (f :: * -> *) :: Meta where ...

Meta field of the M1 type constructor.

Equations

MetaOf (M1 i d f) = d

type family MetaDataName (m :: Meta) :: Symbol where ...

Name of the data type (MetaData).

Equations

MetaDataName (MetaData n _m _p _nt) = n

type family MetaDataModule (m :: Meta) :: Symbol where ...

Name of the module where the data type is defined (MetaData)

Equations

MetaDataModule (MetaData _n m _p _nt) = m

type family MetaDataPackage (m :: Meta) :: Symbol where ...

Name of the package where the data type is defined (MetaData)

Equations

MetaDataPackage (MetaData _n _m p _nt) = p

type family MetaDataNewtype (m :: Meta) :: Bool where ...

True if the data type is a newtype (MetaData).

Equations

MetaDataNewtype (MetaData _n _m _p nt) = nt

type family MetaConsName (m :: Meta) :: Symbol where ...

Name of the constructor (MetaCons).

Equations

MetaConsName (MetaCons n _f _s) = n

type family MetaConsFixity (m :: Meta) :: FixityI where ...

Fixity of the constructor (MetaCons).

Equations

MetaConsFixity (MetaCons _n f s) = f

type family MetaConsRecord (m :: Meta) :: Bool where ...

True for a record constructor (MetaCons).

Equations

MetaConsRecord (MetaCons _n _f s) = s

type family MetaSelNameM (m :: Meta) :: Maybe Symbol where ...

Just the name of the record field, if it is one (MetaSel).

Equations

MetaSelNameM (MetaSel mn _su _ss _ds) = mn

type family MetaSelName (m :: Meta) :: Symbol where ...

Name of the record field; undefined for non-record fields (MetaSel).

Equations

MetaSelName (MetaSel (Just n) _su _ss _ds) = n

type family MetaSelUnpack (m :: Meta) :: SourceUnpackedness where ...

Unpackedness annotation of a field (MetaSel).

Equations

MetaSelUnpack (MetaSel _mn su _ss _ds) = su

type family MetaSelSourceStrictness (m :: Meta) :: SourceStrictness where ...

Strictness annotation of a field (MetaSel).

Equations

MetaSelSourceStrictness (MetaSel _mn _su ss _ds) = ss

type family MetaSelStrictness (m :: Meta) :: DecidedStrictness where ...

Inferred strictness of a field (MetaSel).

Equations

MetaSelStrictness (MetaSel _mn _su _ss ds) = ds