Type.Reflection.Name

This module provides three different ways of serializing a TypeRep into a Text: qualifying no names, qualifying all names, or package-qualifying all names. In order to support meaningful notions of equality on these string representations (for e.g. using them as keys in a map), newtypes are provided for each format.

Unqualified names

newtype Unqualified

A rendering of a type where no components have module or package qualifications. Data constructors used in types are preceded with a ', and infix operator types are printed without parentheses. Uses defaultRenderTypeRep to render types; see that function for further details.

Constructors

MkUnqualified Text

Instances

IsString Unqualified

Defined in Type.Reflection.Name

Methods

fromString :: String -> Unqualified

Monoid Unqualified

Defined in Type.Reflection.Name

Methods

mempty :: Unqualified

mappend :: Unqualified -> Unqualified -> Unqualified

mconcat :: [Unqualified] -> Unqualified

Semigroup Unqualified

Defined in Type.Reflection.Name

Methods

(<>) :: Unqualified -> Unqualified -> Unqualified

sconcat :: NonEmpty Unqualified -> Unqualified

stimes :: Integral b => b -> Unqualified -> Unqualified

Show Unqualified

Defined in Type.Reflection.Name

Methods

showsPrec :: Int -> Unqualified -> ShowS

show :: Unqualified -> String

showList :: [Unqualified] -> ShowS

Eq Unqualified

Defined in Type.Reflection.Name

Methods

(==) :: Unqualified -> Unqualified -> Bool

(/=) :: Unqualified -> Unqualified -> Bool

Ord Unqualified

Defined in Type.Reflection.Name

Methods

compare :: Unqualified -> Unqualified -> Ordering

(<) :: Unqualified -> Unqualified -> Bool

(<=) :: Unqualified -> Unqualified -> Bool

(>) :: Unqualified -> Unqualified -> Bool

(>=) :: Unqualified -> Unqualified -> Bool

max :: Unqualified -> Unqualified -> Unqualified

min :: Unqualified -> Unqualified -> Unqualified

Hashable Unqualified

Defined in Type.Reflection.Name

Methods

hashWithSalt :: Int -> Unqualified -> Int

hash :: Unqualified -> Int

TypeText Unqualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> Unqualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> Unqualified

getUnqualified :: Unqualified -> Text

Extract the contents of an Unqualified rendering

showUnqualified :: TypeRep t -> Unqualified

Convert a TypeRep into an Unqualified representation

Qualified names

newtype Qualified

A rendering of a type where all components have module qualifications. Data constructors used in types are preceded first with their module qualification, and then with a ', and infix operator types are printed without parentheses. So we have Data.Proxy.'Proxy for the Proxy constructor. Uses defaultRenderTypeRep to render types; see that function for further details.j

Note that module qualifications arise from the module that defines a type, even if this is a hidden or internal module. This fact means that internal-structure changes in your libraries may affect how your types are rendered, including changes in e.g. base.

Constructors

MkQualified Text

Instances

IsString Qualified

Defined in Type.Reflection.Name

Methods

fromString :: String -> Qualified

Monoid Qualified

Defined in Type.Reflection.Name

Methods

mempty :: Qualified

mappend :: Qualified -> Qualified -> Qualified

mconcat :: [Qualified] -> Qualified

Semigroup Qualified

Defined in Type.Reflection.Name

Methods

(<>) :: Qualified -> Qualified -> Qualified

sconcat :: NonEmpty Qualified -> Qualified

stimes :: Integral b => b -> Qualified -> Qualified

Show Qualified

Defined in Type.Reflection.Name

Methods

showsPrec :: Int -> Qualified -> ShowS

show :: Qualified -> String

showList :: [Qualified] -> ShowS

Eq Qualified

Defined in Type.Reflection.Name

Methods

(==) :: Qualified -> Qualified -> Bool

(/=) :: Qualified -> Qualified -> Bool

Ord Qualified

Defined in Type.Reflection.Name

Methods

compare :: Qualified -> Qualified -> Ordering

(<) :: Qualified -> Qualified -> Bool

(<=) :: Qualified -> Qualified -> Bool

(>) :: Qualified -> Qualified -> Bool

(>=) :: Qualified -> Qualified -> Bool

max :: Qualified -> Qualified -> Qualified

min :: Qualified -> Qualified -> Qualified

Hashable Qualified

Defined in Type.Reflection.Name

Methods

hashWithSalt :: Int -> Qualified -> Int

hash :: Qualified -> Int

TypeText Qualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> Qualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> Qualified

getQualified :: Qualified -> Text

Extract the contents of a Qualified rendering

showQualified :: TypeRep t -> Qualified

Convert a TypeRep into a Qualified representation

Package-qualified names

newtype PackageQualified

A rendering of a type where all components have package and module qualifications Data constructors used in types are preceded first with their package qualification, and then their module qualification, and then with a ', and infix operator types are printed without parentheses. So we have base.Data.Proxy.'Proxy for the Proxy constructor. Uses defaultRenderTypeRep to render types; see that function for further details.

Note that module qualifications arise from the module that defines a type, even if this is a hidden or internal module. This fact means that internal-structure changes in your libraries may affect how your types are rendered, including changes in e.g. base.

Constructors

MkPackageQualified Text

Instances

IsString PackageQualified

Defined in Type.Reflection.Name

Methods

fromString :: String -> PackageQualified

Monoid PackageQualified

Defined in Type.Reflection.Name

Methods

mempty :: PackageQualified

mappend :: PackageQualified -> PackageQualified -> PackageQualified

mconcat :: [PackageQualified] -> PackageQualified

Semigroup PackageQualified

Defined in Type.Reflection.Name

Methods

(<>) :: PackageQualified -> PackageQualified -> PackageQualified

sconcat :: NonEmpty PackageQualified -> PackageQualified

stimes :: Integral b => b -> PackageQualified -> PackageQualified

Show PackageQualified

Defined in Type.Reflection.Name

Methods

showsPrec :: Int -> PackageQualified -> ShowS

show :: PackageQualified -> String

showList :: [PackageQualified] -> ShowS

Eq PackageQualified

Defined in Type.Reflection.Name

Methods

(==) :: PackageQualified -> PackageQualified -> Bool

(/=) :: PackageQualified -> PackageQualified -> Bool

Ord PackageQualified

Defined in Type.Reflection.Name

Methods

compare :: PackageQualified -> PackageQualified -> Ordering

(<) :: PackageQualified -> PackageQualified -> Bool

(<=) :: PackageQualified -> PackageQualified -> Bool

(>) :: PackageQualified -> PackageQualified -> Bool

(>=) :: PackageQualified -> PackageQualified -> Bool

max :: PackageQualified -> PackageQualified -> PackageQualified

min :: PackageQualified -> PackageQualified -> PackageQualified

Hashable PackageQualified

Defined in Type.Reflection.Name

Methods

hashWithSalt :: Int -> PackageQualified -> Int

hash :: PackageQualified -> Int

TypeText PackageQualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> PackageQualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> PackageQualified

getPackageQualified :: PackageQualified -> Text

Extract the contents of a PackageQualified name

showPackageQualified :: TypeRep t -> PackageQualified

Convert a TypeRep into a PackageQualified representation

Class-based access

class (IsString tt, Monoid tt, Ord tt) => TypeText tt where

The TypeText class describes how a TyCon is rendered into a textual representation, and it is used to render a TypeRep by renderTypeRep. The IsString superclass is needed to insert connectives like spaces, dots, and parentheses, and the Monoid superclass is needed to stitch these pieces together.

Only renderTyCon is needed for instances; if renderTypeRep is omitted, then the default rendering, via defaultRenderTypeRep is used. See that function for more details.

The only consistency law for TypeText is this, holding for all tr of type TypeRep :

case tr of Con' tc [] -> renderTypeRep tr == renderTyCon tc
           _ -> True

In other words, rendering a TypeRep consisting only of a TyCon is the same as rendering the TyCon itself. If the TypeRep is not a plain TyCon (with no kind arguments), then there are no applicable laws. Note that the law uses ==, even though Eq is not a superclass of TypeText.

Minimal complete definition

renderTyCon

Methods

renderTyCon :: TyCon -> tt

renderTypeRep :: TypeRep t -> tt

Instances

TypeText PackageQualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> PackageQualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> PackageQualified

TypeText Qualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> Qualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> Qualified

TypeText Unqualified

Defined in Type.Reflection.Name

Methods

renderTyCon :: TyCon -> Unqualified

renderTypeRep :: forall {k} (t :: k). TypeRep t -> Unqualified

defaultRenderTypeRep :: forall tn outer_t. TypeText tn => TypeRep outer_t -> tn

Render a TypeRep into an instance of TypeText. This follows the following rules for how to render a type:

• Function types are rendered infix. If a function takes another function as an argument, the argument function is rendered in parentheses (as required by the right-associative -> operator).
• All other type constructors are rendered prefix, including the list constructor [] and the tuple constructors e.g. (,,), along with any other type operators.
• All kind arguments to type constructors are rendered, with @ prefixes. Any non-atomic (that is, not simply a type constructor with no kind arguments) kinds are enclosed in parentheses.
• Non-atomic arguments are enclosed in parentheses.
• Type synonyms are always expanded. This means that we get [] Char, not String, and we get TYPE ('BoxedRep 'Lifted), not Type.