PatSyn

ghc-8.6.3: The GHC API

Safe Haskell | None
Language | Haskell2010

PatSyn

Contents

- Main data types
  - Type deconstruction

Synopsis

- data PatSyn
- mkPatSyn :: Name -> Bool -> ([TyVarBinder], ThetaType) -> ([TyVarBinder], ThetaType) -> [Type] -> Type -> (Id, Bool) -> Maybe (Id, Bool) -> [FieldLabel] -> PatSyn
- patSynName :: PatSyn -> Name
- patSynArity :: PatSyn -> Arity
- patSynIsInfix :: PatSyn -> Bool
- patSynArgs :: PatSyn -> [Type]
- patSynMatcher :: PatSyn -> (Id, Bool)
- patSynBuilder :: PatSyn -> Maybe (Id, Bool)
- patSynUnivTyVarBinders :: PatSyn -> [TyVarBinder]
- patSynExTyVars :: PatSyn -> [TyVar]
- patSynExTyVarBinders :: PatSyn -> [TyVarBinder]
- patSynSig :: PatSyn -> ([TyVar], ThetaType, [TyVar], ThetaType, [Type], Type)
- patSynInstArgTys :: PatSyn -> [Type] -> [Type]
- patSynInstResTy :: PatSyn -> [Type] -> Type
- patSynFieldLabels :: PatSyn -> [FieldLabel]
- patSynFieldType :: PatSyn -> FieldLabelString -> Type
- tidyPatSynIds :: (Id -> Id) -> PatSyn -> PatSyn
- pprPatSynType :: PatSyn -> SDoc

# Main data types

data PatSyn #

Pattern Synonym

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

Instances

Eq PatSyn # |
Instance details Defined in PatSyn Methods (==) :: PatSyn -> PatSyn -> Bool # (/=) :: PatSyn -> PatSyn -> Bool #
Data PatSyn # |
Instance details Defined in PatSyn Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PatSyn -> c PatSyn Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PatSyn Source # toConstr :: PatSyn -> Constr Source # dataTypeOf :: PatSyn -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PatSyn) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PatSyn) Source # gmapT :: (forall b. Data b => b -> b) -> PatSyn -> PatSyn Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PatSyn -> r Source # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PatSyn -> r Source # gmapQ :: (forall d. Data d => d -> u) -> PatSyn -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> PatSyn -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PatSyn -> m PatSyn Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PatSyn -> m PatSyn Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PatSyn -> m PatSyn Source #
OutputableBndr PatSyn # |
Instance details Defined in PatSyn Methods pprBndr :: BindingSite -> PatSyn -> SDoc # pprPrefixOcc :: PatSyn -> SDoc # pprInfixOcc :: PatSyn -> SDoc # bndrIsJoin_maybe :: PatSyn -> Maybe Int #
Outputable PatSyn # |
Instance details Defined in PatSyn Methods ppr :: PatSyn -> SDoc # pprPrec :: Rational -> PatSyn -> SDoc #
Uniquable PatSyn # |
Instance details Defined in PatSyn Methods getUnique :: PatSyn -> Unique #
NamedThing PatSyn # |
Instance details Defined in PatSyn Methods getOccName :: PatSyn -> OccName # getName :: PatSyn -> Name #

mkPatSyn #

Arguments

:: Name |
-> Bool | Is the pattern synonym declared infix?
-> ([TyVarBinder], ThetaType) | Universially-quantified type variables and required dicts
-> ([TyVarBinder], ThetaType) | Existentially-quantified type variables and provided dicts
-> [Type] | Original arguments
-> Type | Original result type
-> (Id, Bool) | Name of matcher
-> Maybe (Id, Bool) | Name of builder
-> [FieldLabel] | Names of fields for a record pattern synonym
-> PatSyn |

Build a new pattern synonym

## Type deconstruction

patSynName :: PatSyn -> Name #

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

patSynArity :: PatSyn -> Arity #

Arity of the pattern synonym

patSynIsInfix :: PatSyn -> Bool #

Should the `PatSyn` be presented infix?

patSynArgs :: PatSyn -> [Type] #

patSynMatcher :: PatSyn -> (Id, Bool) #

patSynBuilder :: PatSyn -> Maybe (Id, Bool) #

patSynUnivTyVarBinders :: PatSyn -> [TyVarBinder] #

patSynExTyVars :: PatSyn -> [TyVar] #

patSynExTyVarBinders :: PatSyn -> [TyVarBinder] #

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

patSynInstArgTys :: PatSyn -> [Type] -> [Type] #

patSynInstResTy :: PatSyn -> [Type] -> Type #

patSynFieldLabels :: PatSyn -> [FieldLabel] #

patSynFieldType :: PatSyn -> FieldLabelString -> Type #

Extract the type for any given labelled field of the `DataCon`

tidyPatSynIds :: (Id -> Id) -> PatSyn -> PatSyn #

pprPatSynType :: PatSyn -> SDoc #

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