Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Moduleghc-10.0.0.20260917GHC2024

GHC.Core.PatSyn

Contents

Main data types
Type deconstruction

Synopsis

data PatSyn
type PatSynMatcher
type PatSynBuilder
value mkPatSyn
value patSynName
value patSynArity
value patSynVisArity
value patSynIsInfix
value patSynResultType
value isVanillaPatSyn
value patSynArgs
value patSynMatcher
value patSynBuilder
value patSynUnivTyVarBinders
value patSynExTyVars
value patSynExTyVarBinders
value patSynSig
value patSynSigBndr
value patSynInstArgTys
value patSynInstResTy
value patSynFieldLabels
value patSynFieldType
value pprPatSynType

Packageghc-10.0.0.20260917
Exports23
LanguageGHC2024
LicenceBSD-3-Clause
SourcePatSyn.hs

Main data types

datadata PatSyn

Pattern Synonym

See Note [Pattern synonym representation] See Note [Pattern synonym signature contexts]

Constructors

MkPatSyn
- psName :: Name
- psUnique :: Unique
- psArgs :: [FRRType]
  Argument types
- psArity :: Arity
- psInfix :: Bool
- psFieldLabels :: [FieldLabel]
- psUnivTyVars :: [InvisTVBinder]
- psReqTheta :: ThetaType
- psExTyVars :: [InvisTVBinder]
- psProvTheta :: ThetaType
- psResultTy :: Type
- psMatcher :: PatSynMatcher
- psBuilder :: PatSynBuilder

Instances6Eq, Data, NamedThing, Outputable, Uniquable, OutputableBndr

Eq PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn
Data PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn
NamedThing PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn
Outputable PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn
Uniquable PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn
OutputableBndr PatSynDefined in ghc-10.0.0.20260917 · GHC.Core.PatSyn

typetype PatSynMatcher = (Name, Type, Bool)

typetype PatSynBuilder = Maybe (Name, Type, Bool)

valuemkPatSyn

:: Name
-> Bool
Is the pattern synonym declared infix?
-> ([InvisTVBinder], ThetaType)
Universally-quantified type variables and required dicts
-> ([InvisTVBinder], ThetaType)
Existentially-quantified type variables and provided dicts
-> [FRRType]
Original arguments
-> Type
Original result type
-> PatSynMatcher
Matcher
-> PatSynBuilder
Builder
-> [FieldLabel]
Names of fields for a record pattern synonym
-> PatSyn

Build a new pattern synonym

Type deconstruction

valuepatSynName :: PatSyn -> Name

The Name of the PatSyn, giving it a unique, rooted identification

valuepatSynArity :: PatSyn -> Arity

Arity of the pattern synonym

valuepatSynVisArity :: PatSyn -> VisArity

Number of visible arguments of the pattern synonym

valuepatSynIsInfix :: PatSyn -> Bool

Should the PatSyn be presented infix?

valuepatSynResultType :: PatSyn -> Type

valueisVanillaPatSyn :: PatSyn -> Bool

Is this a 'vanilla' pattern synonym (no existentials, no provided constraints)?

valuepatSynArgs :: PatSyn -> [Type]

valuepatSynMatcher :: PatSyn -> PatSynMatcher

valuepatSynBuilder :: PatSyn -> PatSynBuilder

valuepatSynUnivTyVarBinders :: PatSyn -> [InvisTVBinder]

valuepatSynExTyVars :: PatSyn -> [TyVar]

valuepatSynExTyVarBinders :: PatSyn -> [InvisTVBinder]

valuepatSynSig

:: PatSyn
-> ([TyVar], ThetaType, [TyVar], ThetaType, [Scaled Type], Type)

valuepatSynSigBndr

:: PatSyn
-> ([InvisTVBinder], ThetaType, [InvisTVBinder], ThetaType, [Scaled Type], Type)

valuepatSynInstArgTys :: PatSyn -> [Type] -> [Type]

valuepatSynInstResTy :: PatSyn -> [Type] -> Type

valuepatSynFieldLabels :: PatSyn -> [FieldLabel]

valuepatSynFieldType :: PatSyn -> FieldLabelString -> Type

Extract the type for any given labelled field of the DataCon

valuepprPatSynType :: PatSyn -> SDoc

Print the type of a pattern synonym. The foralls are printed explicitly