Language.Haskell.TH.Lib · template-haskell-2.22.0.0

Deprecated. As of template-haskell-2.10, constraint predicates (Pred) are just types (Type), in keeping with ConstraintKinds. Please use conT and appT.

valueequalP :: Quote m => m Type -> m Type -> m Pred

#

Deprecated. As of template-haskell-2.10, constraint predicates (Pred) are just types (Type), in keeping with ConstraintKinds. Please see equalityT.

Constructors

valuenormalC :: Quote m => Name -> [m BangType] -> m Con

#

valuerecC :: Quote m => Name -> [m VarBangType] -> m Con

#

valueinfixC :: Quote m => m (Bang, Type) -> Name -> m (Bang, Type) -> m Con

#

valueforallC :: Quote m => [TyVarBndr Specificity] -> m Cxt -> m Con -> m Con

#

valuegadtC :: Quote m => [Name] -> [m StrictType] -> m Type -> m Con

#

valuerecGadtC :: Quote m => [Name] -> [m VarStrictType] -> m Type -> m Con

#

Kinds

valuevarK :: Name -> Kind

#

valueconK :: Name -> Kind

#

valuetupleK :: Int -> Kind

#

valuearrowK :: Kind

#

valuelistK :: Kind

#

valueappK :: Kind -> Kind -> Kind

#

valuestarK :: Kind

#

valueconstraintK :: Kind

#

Type variable binders

classclass DefaultBndrFlag flag where

#

Methods

defaultBndrFlag :: flag

Instances3DefaultBndrFlag

DefaultBndrFlag BndrVisDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Lib
DefaultBndrFlag SpecificityDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Lib
DefaultBndrFlag ()Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Lib

valueplainTV :: DefaultBndrFlag flag => Name -> TyVarBndr flag

#

valuekindedTV :: DefaultBndrFlag flag => Name -> Kind -> TyVarBndr flag

#

valueplainInvisTV :: Quote m => Name -> Specificity -> m (TyVarBndr Specificity)

#

valuekindedInvisTV

:: Quote m
=> Name
-> Specificity
-> m Kind
-> m (TyVarBndr Specificity)

#

valueplainBndrTV :: Quote m => Name -> BndrVis -> m (TyVarBndr BndrVis)

#

valuekindedBndrTV

:: Quote m
=> Name
-> BndrVis
-> m Kind
-> m (TyVarBndr BndrVis)

#

valuespecifiedSpec :: Specificity

#

valueinferredSpec :: Specificity

#

valuebndrReq :: BndrVis

#

valuebndrInvis :: BndrVis

#

Roles

valuenominalR :: Role

#

valuerepresentationalR :: Role

#

valuephantomR :: Role

#

valueinferR :: Role

#

Top Level Declarations

Data

valuevalD :: Quote m => m Pat -> m Body -> [m Dec] -> m Dec

#

valuefunD :: Quote m => Name -> [m Clause] -> m Dec

#

valuetySynD :: Quote m => Name -> [TyVarBndr BndrVis] -> m Type -> m Dec

#

valuedataD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> [m Con]
-> [m DerivClause]
-> m Dec

#

valuenewtypeD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> m Con
-> [m DerivClause]
-> m Dec

#

valuetypeDataD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> Maybe Kind
-> [m Con]
-> m Dec

#

valuederivClause :: Quote m => Maybe DerivStrategy -> [m Pred] -> m DerivClause

#

datadata DerivClause

#

A single deriving clause at the end of a datatype.

Constructors

DerivClause (Maybe DerivStrategy) Cxt
```
{ deriving stock (Eq, Ord) }
```

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq DerivClauseDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Data DerivClauseDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Ord DerivClauseDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Show DerivClauseDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Generic DerivClauseDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
type Rep DerivClause = D1 ('MetaData "DerivClause" "Language.Haskell.TH.Syntax" "template-haskell" 'False) (C1 ('MetaCons "DerivClause" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DerivStrategy)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cxt)))Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax

valuestockStrategy :: Quote m => m DerivStrategy

#

valueanyclassStrategy :: Quote m => m DerivStrategy

#

valuenewtypeStrategy :: Quote m => m DerivStrategy

#

valueviaStrategy :: Quote m => m Type -> m DerivStrategy

#

datadata DerivStrategy

#

What the user explicitly requests when deriving an instance.

Constructors

StockStrategy
A "standard" derived instance
AnyclassStrategy
```
-XDeriveAnyClass
```
NewtypeStrategy
```
-XGeneralizedNewtypeDeriving
```
ViaStrategy Type
```
-XDerivingVia
```

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq DerivStrategyDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Data DerivStrategyDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Ord DerivStrategyDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Show DerivStrategyDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Generic DerivStrategyDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
type Rep DerivStrategy = D1 ('MetaData "DerivStrategy" "Language.Haskell.TH.Syntax" "template-haskell" 'False) ((C1 ('MetaCons "StockStrategy" 'PrefixI 'False) U1 :+: C1 ('MetaCons "AnyclassStrategy" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "NewtypeStrategy" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ViaStrategy" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type))))Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax

Class

valueclassD

:: Quote m
=> m Cxt
-> Name
-> [TyVarBndr BndrVis]
-> [FunDep]
-> [m Dec]
-> m Dec

#

valueinstanceD :: Quote m => m Cxt -> m Type -> [m Dec] -> m Dec

#

valueinstanceWithOverlapD

:: Quote m
=> Maybe Overlap
-> m Cxt
-> m Type
-> [m Dec]
-> m Dec

#

datadata Overlap

#

Varieties of allowed instance overlap.

Constructors

Overlappable
May be overlapped by more specific instances
Overlapping
May overlap a more general instance
Overlaps
Both Overlapping and Overlappable
Incoherent
Both Overlapping and Overlappable, and pick an arbitrary one if multiple choices are available.

Instances6Eq, Data, Ord, Show, Generic, Rep

Eq OverlapDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Data OverlapDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Ord OverlapDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Show OverlapDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
Generic OverlapDefined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax
type Rep Overlap = D1 ('MetaData "Overlap" "Language.Haskell.TH.Syntax" "template-haskell" 'False) ((C1 ('MetaCons "Overlappable" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Overlapping" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Overlaps" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Incoherent" 'PrefixI 'False) U1))Defined in template-haskell-2.22.0.0 · Language.Haskell.TH.Syntax

valuesigD :: Quote m => Name -> m Type -> m Dec

#

valuekiSigD :: Quote m => Name -> m Kind -> m Dec

#

valuestandaloneDerivD :: Quote m => m Cxt -> m Type -> m Dec

#

valuestandaloneDerivWithStrategyD

:: Quote m
=> Maybe DerivStrategy
-> m Cxt
-> m Type
-> m Dec

#

valuedefaultSigD :: Quote m => Name -> m Type -> m Dec

#

Role annotations

valueroleAnnotD :: Quote m => Name -> [Role] -> m Dec

#

Type Family / Data Family

valuedataFamilyD :: Quote m => Name -> [TyVarBndr BndrVis] -> Maybe Kind -> m Dec

#

valueopenTypeFamilyD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> FamilyResultSig
-> Maybe InjectivityAnn
-> m Dec

#

valueclosedTypeFamilyD

:: Quote m
=> Name
-> [TyVarBndr BndrVis]
-> FamilyResultSig
-> Maybe InjectivityAnn
-> [m TySynEqn]
-> m Dec

#

valuedataInstD

:: Quote m
=> m Cxt
-> Name
-> [m Type]
-> Maybe Kind
-> [m Con]
-> [m DerivClause]
-> m Dec

#

valuenewtypeInstD

:: Quote m
=> m Cxt
-> Name
-> [m Type]
-> Maybe Kind
-> m Con
-> [m DerivClause]
-> m Dec

#

valuetySynInstD :: Quote m => m TySynEqn -> m Dec

#

valuetySynEqn

:: Quote m
=> Maybe [TyVarBndr ()]
-> m Type
-> m Type
-> m TySynEqn

#

valueinjectivityAnn :: Name -> [Name] -> InjectivityAnn

#

valuenoSig :: FamilyResultSig

#

valuekindSig :: Kind -> FamilyResultSig

#

valuetyVarSig :: TyVarBndr () -> FamilyResultSig

#

Fixity

valueinfixLD :: Quote m => Int -> Name -> m Dec

#

valueinfixRD :: Quote m => Int -> Name -> m Dec

#

valueinfixND :: Quote m => Int -> Name -> m Dec

#

Default declaration

valuedefaultD :: Quote m => [m Type] -> m Dec

#

Foreign Function Interface (FFI)

valuecCall :: Callconv

#

valuestdCall :: Callconv

#

valuecApi :: Callconv

#

valueprim :: Callconv

#

valuejavaScript :: Callconv

#

valueunsafe :: Safety

#

valuesafe :: Safety

#

valueinterruptible :: Safety

#

valueforImpD

:: Quote m
=> Callconv
-> Safety
-> String
-> Name
-> m Type
-> m Dec

#

Functional dependencies

valuefunDep :: [Name] -> [Name] -> FunDep

#

Pragmas

valueruleVar :: Quote m => Name -> m RuleBndr

#

valuetypedRuleVar :: Quote m => Name -> m Type -> m RuleBndr

#

valuevalueAnnotation :: Name -> AnnTarget

#

valuetypeAnnotation :: Name -> AnnTarget

#

valuemoduleAnnotation :: AnnTarget

#

valuepragInlD :: Quote m => Name -> Inline -> RuleMatch -> Phases -> m Dec

#

valuepragSpecD :: Quote m => Name -> m Type -> Phases -> m Dec

#

valuepragSpecInlD :: Quote m => Name -> m Type -> Inline -> Phases -> m Dec

#

valuepragSpecInstD :: Quote m => m Type -> m Dec

#

valuepragRuleD

:: Quote m
=> String
-> [m RuleBndr]
-> m Exp
-> m Exp
-> Phases
-> m Dec

#

valuepragAnnD :: Quote m => AnnTarget -> m Exp -> m Dec

#

valuepragLineD :: Quote m => Int -> String -> m Dec

#

valuepragCompleteD :: Quote m => [Name] -> Maybe Name -> m Dec

#

Pattern Synonyms

valuepatSynD :: Quote m => Name -> m PatSynArgs -> m PatSynDir -> m Pat -> m Dec

#

Pattern synonym declaration

valuepatSynSigD :: Quote m => Name -> m Type -> m Dec

#

Pattern synonym type signature

valueunidir :: Quote m => m PatSynDir

#

valueimplBidir :: Quote m => m PatSynDir

#

valueexplBidir :: Quote m => [m Clause] -> m PatSynDir

#

valueprefixPatSyn :: Quote m => [Name] -> m PatSynArgs

#

valueinfixPatSyn :: Quote m => Name -> Name -> m PatSynArgs

#

valuerecordPatSyn :: Quote m => [Name] -> m PatSynArgs

#

Implicit Parameters

valueimplicitParamBindD :: Quote m => String -> m Exp -> m Dec

#

Implicit parameter binding declaration. Can only be used in let and where clauses which consist entirely of implicit bindings.

Reify

valuethisModule :: Q Module

#

pure the Module at the place of splicing. Can be used as an input for reifyModule.

Documentation

valuewithDecDoc :: String -> Q Dec -> Q Dec

#

Attaches Haddock documentation to the declaration provided. Unlike putDoc, the names do not need to be in scope when calling this function so it can be used for quoted declarations and anything else currently being spliced. Not all declarations can have documentation attached to them. For those that can't, withDecDoc will return it unchanged without any side effects.

valuewithDecsDoc :: String -> Q [Dec] -> Q [Dec]

#

Variant of withDecDoc that applies the same documentation to multiple declarations. Useful for documenting quoted declarations.

valuefunD_doc

:: Name
-> [Q Clause]
-> Maybe String
Documentation to attach to function
-> [Maybe String]
Documentation to attach to arguments
-> Q Dec

#

Variant of funD that attaches Haddock documentation.

valuedataD_doc

:: Q Cxt
-> Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the data declaration
-> Q Dec

#

Variant of dataD that attaches Haddock documentation.

valuenewtypeD_doc

:: Q Cxt
-> Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> (Q Con, Maybe String, [Maybe String])
The constructor, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the newtype declaration
-> Q Dec

#

Variant of newtypeD that attaches Haddock documentation.

valuetypeDataD_doc

:: Name
-> [Q (TyVarBndr BndrVis)]
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> Maybe String
Documentation to attach to the data declaration
-> Q Dec

#

Variant of typeDataD that attaches Haddock documentation.

valuedataInstD_doc

:: Q Cxt
-> Maybe [Q (TyVarBndr ())]
-> Q Type
-> Maybe (Q Kind)
-> [(Q Con, Maybe String, [Maybe String])]
List of constructors, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the instance declaration
-> Q Dec

#

Variant of dataInstD that attaches Haddock documentation.

valuenewtypeInstD_doc

:: Q Cxt
-> Maybe [Q (TyVarBndr ())]
-> Q Type
-> Maybe (Q Kind)
-> (Q Con, Maybe String, [Maybe String])
The constructor, documentation for the constructor, and documentation for the arguments
-> [Q DerivClause]
-> Maybe String
Documentation to attach to the instance declaration
-> Q Dec

#

Variant of newtypeInstD that attaches Haddock documentation.

valuepatSynD_doc

:: Name
-> Q PatSynArgs
-> Q PatSynDir
-> Q Pat
-> Maybe String
Documentation to attach to the pattern synonym
-> [Maybe String]
Documentation to attach to the pattern arguments
-> Q Dec

#

Variant of patSynD that attaches Haddock documentation.