OPENFPDocsall docsSearch names, modules, packages, or :: a typeCtrl K

GHC 9.10.3

Modulevortex-trace-0.4.0GHC2024

Vortex.Trace.Signature

A reflected signature (a Vortex.Trace.Command's commandType) cut into the pieces a front end links: every type constructor it names is a Named piece with the key a documentation index knows it by, and everything else is Plain text. The pieces spell the signature exactly, so a front end that renders each piece's text loses nothing.

  • 1 type
  • 3 values
datadata Piece
#

A run of a signature: text to show as it is, or a type constructor's text with its unqualified name, the key a link is looked up by.

Constructors

  • Plain String

    Text with nothing to link: arrows, variables, spaces, punctuation.

  • Named String String

    A type constructor as written, then its key (Named Data.Map.Map Map).

Instances2Eq, Show
  • Eq PieceDefined in vortex-trace-0.4.0 · Vortex.Trace.Signature
  • Show PieceDefined in vortex-trace-0.4.0 · Vortex.Trace.Signature
valuesignaturePieces :: String -> [Piece]
#

The pieces of a signature, which spell it exactly (concatMap pieceText . signaturePieces = id), with no two Plain pieces adjacent and none empty.