Copyright	(C) 2012-2016 University of Twente 2017 Google Inc.
License	BSD2 (see the file LICENSE)
Maintainer	Christiaan Baaij <christiaan.baaij@gmail.com>
Safe Haskell	None
Language	Haskell2010

Clash.Core.DataCon

Description

Data Constructors in CoreHW

Synopsis

data DataCon = MkData {
- dcName :: !DcName
- dcUniq :: !Unique
- dcTag :: !ConTag
- dcType :: !Type
- dcUnivTyVars :: [TyVar]
- dcExtTyVars :: [TyVar]
- dcArgTys :: [Type]
- dcFieldLabels :: [Text]
}
type DcName = Name DataCon
type ConTag = Int

Documentation

data DataCon Source #

Data Constructor

Constructors

MkData

Fields

dcName :: !DcName
Name of the DataCon
dcUniq :: !Unique
Invariant: forall x . dcUniq x ~ nameUniq (dcName x)
dcTag :: !ConTag
Syntactical position in the type definition
dcType :: !Type
Type of the 'DataCon
dcUnivTyVars :: [TyVar]
Universally quantified type-variables, these type variables are also part of the result type of the DataCon
dcExtTyVars :: [TyVar]
Existentially quantified type-variables, these type variables are not part of the result of the DataCon, but only of the arguments.
dcArgTys :: [Type]
Argument types
dcFieldLabels :: [Text]
Names of fields. Used when data constructor is referring to a record type.

Instances

Instances details

Eq DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods (==) :: DataCon -> DataCon -> Bool # (/=) :: DataCon -> DataCon -> Bool #
Ord DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods compare :: DataCon -> DataCon -> Ordering # (<) :: DataCon -> DataCon -> Bool # (<=) :: DataCon -> DataCon -> Bool # (>) :: DataCon -> DataCon -> Bool # (>=) :: DataCon -> DataCon -> Bool # max :: DataCon -> DataCon -> DataCon # min :: DataCon -> DataCon -> DataCon #
Show DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods showsPrec :: Int -> DataCon -> ShowS # show :: DataCon -> String # showList :: [DataCon] -> ShowS #
Generic DataCon Source #
Instance details Defined in Clash.Core.DataCon Associated Types type Rep DataCon :: Type -> Type # Methods from :: DataCon -> Rep DataCon x # to :: Rep DataCon x -> DataCon #
Hashable DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods hashWithSalt :: Int -> DataCon -> Int # hash :: DataCon -> Int #
Binary DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods put :: DataCon -> Put # get :: Get DataCon # putList :: [DataCon] -> Put #
NFData DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods rnf :: DataCon -> () #
Uniquable DataCon Source #
Instance details Defined in Clash.Core.DataCon Methods getUnique :: DataCon -> Unique Source # setUnique :: DataCon -> Unique -> DataCon Source #
PrettyPrec DataCon Source #
Instance details Defined in Clash.Core.Pretty Methods pprPrec :: Monad m => Rational -> DataCon -> m ClashDoc Source # pprPrec' :: Monad m => PrettyOptions -> Rational -> DataCon -> m ClashDoc Source #
type Rep DataCon Source #
Instance details Defined in Clash.Core.DataCon type Rep DataCon = D1 ('MetaData "DataCon" "Clash.Core.DataCon" "clash-lib-1.3.0-inplace" 'False) (C1 ('MetaCons "MkData" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dcName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DcName) :: S1 ('MetaSel ('Just "dcUniq") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Unique)) :: (S1 ('MetaSel ('Just "dcTag") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConTag) :: S1 ('MetaSel ('Just "dcType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Type))) :: ((S1 ('MetaSel ('Just "dcUnivTyVars") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TyVar]) :: S1 ('MetaSel ('Just "dcExtTyVars") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TyVar])) :: (S1 ('MetaSel ('Just "dcArgTys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Type]) :*: S1 ('MetaSel ('Just "dcFieldLabels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))))

type DcName = Name DataCon Source #

DataCon reference

type ConTag = Int Source #

Syntactical position of the DataCon in the type definition