Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Language.PureScript.Docs.Types
Synopsis
- data Module = Module {
- modName :: ModuleName
- modComments :: Maybe Text
- modDeclarations :: [Declaration]
- modReExports :: [(InPackage ModuleName, [Declaration])]
- data Declaration = Declaration {}
- data ChildDeclaration = ChildDeclaration {}
- data ChildDeclarationInfo
- data InPackage a
- = Local a
- | FromDep PackageName a
- data DeclarationInfo
- = ValueDeclaration Type'
- | DataDeclaration DataDeclType [(Text, Maybe Type')] [Role]
- | ExternDataDeclaration Type' [Role]
- | TypeSynonymDeclaration [(Text, Maybe Type')] Type'
- | TypeClassDeclaration [(Text, Maybe Type')] [Constraint'] [([Text], [Text])]
- | AliasDeclaration Fixity FixityAlias
- data KindInfo = KindInfo {}
- type Type' = Type ()
- type Constraint' = Constraint ()
- data PackageError
- data ManifestError
- data Package a = Package {
- pkgMeta :: PackageMeta
- pkgVersion :: Version
- pkgVersionTag :: Text
- pkgTagTime :: Maybe UTCTime
- pkgModules :: [Module]
- pkgModuleMap :: Map ModuleName PackageName
- pkgResolvedDependencies :: [(PackageName, Version)]
- pkgGithub :: (GithubUser, GithubRepo)
- pkgUploader :: a
- pkgCompilerVersion :: Version
- newtype GithubUser = GithubUser {}
- newtype GithubRepo = GithubRepo {}
- data NotYetKnown = NotYetKnown
- type UploadedPackage = Package NotYetKnown
- type VerifiedPackage = Package GithubUser
- data LinksContext = LinksContext {
- ctxGithub :: (GithubUser, GithubRepo)
- ctxModuleMap :: Map ModuleName PackageName
- ctxResolvedDependencies :: [(PackageName, Version)]
- ctxPackageName :: PackageName
- ctxVersion :: Version
- ctxVersionTag :: Text
- data DocLink = DocLink {}
- data LinkLocation
- packageName :: Package a -> PackageName
- formatTime :: UTCTime -> String
- parseTime :: String -> Maybe UTCTime
- ignorePackage :: InPackage a -> a
- asModule :: Parse PackageError Module
- displayPackageError :: PackageError -> Text
- convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])]
- isType :: Declaration -> Bool
- isTypeClass :: Declaration -> Bool
- isTypeClassMember :: ChildDeclaration -> Bool
- kindSignatureForKeyword :: KindSignatureFor -> Text
- showManifestError :: ManifestError -> Text
- verifyPackage :: GithubUser -> UploadedPackage -> VerifiedPackage
- jsonTimeFormat :: String
- declInfoToString :: DeclarationInfo -> Text
- declInfoNamespace :: DeclarationInfo -> Namespace
- isValue :: Declaration -> Bool
- isValueAlias :: Declaration -> Bool
- isTypeAlias :: Declaration -> Bool
- filterChildren :: (ChildDeclaration -> Bool) -> Declaration -> Declaration
- childDeclInfoToString :: ChildDeclarationInfo -> Text
- childDeclInfoNamespace :: ChildDeclarationInfo -> Namespace
- isDataConstructor :: ChildDeclaration -> Bool
- getLink :: LinksContext -> ModuleName -> Namespace -> Text -> ContainingModule -> Maybe DocLink
- getLinksContext :: Package a -> LinksContext
- asPackage :: Version -> (forall e. Parse e a) -> Parse PackageError (Package a)
- asVersion :: Parse PackageError Version
- parseTimeEither :: String -> Either PackageError UTCTime
- asResolvedDependencies :: Parse PackageError [(PackageName, Version)]
- asGithub :: Parse e (GithubUser, GithubRepo)
- asModuleMap :: Parse PackageError (Map ModuleName PackageName)
- pOr :: Parse e a -> Parse e a -> Parse e a
- bookmarksAsModuleMap :: Parse ManifestError (Map ModuleName PackageName)
- asUploadedPackage :: Version -> Parse PackageError UploadedPackage
- asNotYetKnown :: Parse e NotYetKnown
- asGithubUser :: Parse e GithubUser
- asDeclaration :: Parse PackageError Declaration
- asReExport :: Parse PackageError (InPackage ModuleName, [Declaration])
- asSourceSpan :: Parse e SourceSpan
- asChildDeclaration :: Parse PackageError ChildDeclaration
- asDeclarationInfo :: Parse PackageError DeclarationInfo
- asKindInfo :: Parse PackageError KindInfo
- asInPackage :: Parse ManifestError a -> Parse ManifestError (InPackage a)
- mapLeft :: (a -> a') -> Either a b -> Either a' b
- asFixity :: Parse PackageError Fixity
- asAssociativity :: Parse PackageError Associativity
- asFixityAlias :: Parse PackageError FixityAlias
- parseAssociativity :: String -> Maybe Associativity
- asType :: Parse e Type'
- asDataDeclType :: Parse PackageError DataDeclType
- asTypeArguments :: Parse PackageError [(Text, Maybe Type')]
- asRole :: Parse PackageError Role
- asConstraint :: Parse PackageError Constraint'
- asFunDeps :: Parse PackageError [([Text], [Text])]
- asKindSignatureFor :: Parse PackageError KindSignatureFor
- asChildDeclarationInfo :: Parse PackageError ChildDeclarationInfo
- asSourcePos :: Parse e SourcePos
- asQualifiedProperName :: Parse e (Qualified (ProperName a))
- parsePackageName' :: Text -> Either PackageError PackageName
- assocListToJSON :: (a -> Key) -> (b -> Text) -> [(a, b)] -> Value
- data RenderedCode
- data RenderedCodeElement
- data ContainingModule
- data Namespace
- type FixityAlias = Qualified (Either (ProperName 'TypeName) (Either Ident (ProperName 'ConstructorName)))
- asContainingModule :: Parse Text ContainingModule
Documentation
Constructors
Module | |
Fields
|
Instances
ToJSON Module # | |
Generic Module # | |
Show Module # | |
NFData Module # | |
Defined in Language.PureScript.Docs.Types | |
Eq Module # | |
Ord Module # | |
type Rep Module # | |
Defined in Language.PureScript.Docs.Types type Rep Module = D1 ('MetaData "Module" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Module" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName) :*: S1 ('MetaSel ('Just "modComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "modDeclarations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Declaration]) :*: S1 ('MetaSel ('Just "modReExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(InPackage ModuleName, [Declaration])])))) |
data Declaration #
Constructors
Declaration | |
Fields
|
Instances
data ChildDeclaration #
Constructors
ChildDeclaration | |
Fields |
Instances
data ChildDeclarationInfo #
Constructors
ChildInstance [Constraint'] Type' | A type instance declaration, with its dependencies and its type. |
ChildDataConstructor [Type'] | A data constructor, with its type arguments. |
ChildTypeClassMember Type' | A type class member, with its type. Note that the type does not include
the type class constraint; this may be added manually if desired. For
example, |
Instances
Constructors
Local a | |
FromDep PackageName a |
Instances
Functor InPackage # | |
ToJSON a => ToJSON (InPackage a) # | |
Generic (InPackage a) # | |
Show a => Show (InPackage a) # | |
NFData a => NFData (InPackage a) # | |
Defined in Language.PureScript.Docs.Types | |
Eq a => Eq (InPackage a) # | |
Ord a => Ord (InPackage a) # | |
Defined in Language.PureScript.Docs.Types | |
type Rep (InPackage a) # | |
Defined in Language.PureScript.Docs.Types type Rep (InPackage a) = D1 ('MetaData "InPackage" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Local" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "FromDep" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a))) |
data DeclarationInfo #
A value of this type contains information that is specific to a particular
kind of declaration (as opposed to information which exists in all kinds of
declarations, which goes into the Declaration
type directly).
Many of the constructors are very similar to their equivalents in the real
PureScript AST, except that they have their name elided, since this is
already available via the rdTitle field of Declaration
.
Constructors
ValueDeclaration Type' | A value declaration, with its type. |
DataDeclaration DataDeclType [(Text, Maybe Type')] [Role] | A data/newtype declaration, with the kind of declaration (data or newtype) and its type arguments. Constructors are represented as child declarations. |
ExternDataDeclaration Type' [Role] | A data type foreign import, with its kind. |
TypeSynonymDeclaration [(Text, Maybe Type')] Type' | A type synonym, with its type arguments and its type. |
TypeClassDeclaration [(Text, Maybe Type')] [Constraint'] [([Text], [Text])] | A type class, with its type arguments, its superclasses and functional dependencies. Instances and members are represented as child declarations. |
AliasDeclaration Fixity FixityAlias | An operator alias declaration, with the member the alias is for and the operator's fixity. |
Instances
Wraps enough information to properly render the kind signature of a datanewtypetype/class declaration.
Constructors
KindInfo | |
Fields
|
Instances
ToJSON KindInfo # | |
Generic KindInfo # | |
Show KindInfo # | |
NFData KindInfo # | |
Defined in Language.PureScript.Docs.Types | |
Eq KindInfo # | |
Ord KindInfo # | |
Defined in Language.PureScript.Docs.Types | |
type Rep KindInfo # | |
Defined in Language.PureScript.Docs.Types type Rep KindInfo = D1 ('MetaData "KindInfo" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "KindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kiKeyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KindSignatureFor) :*: S1 ('MetaSel ('Just "kiKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type'))) |
type Constraint' = Constraint () #
data PackageError #
Constructors
CompilerTooOld Version Version | Minimum allowable version for generating data with the current parser, and actual version used. |
ErrorInPackageMeta ManifestError | |
InvalidVersion | |
InvalidDeclarationType Text | |
InvalidChildDeclarationType Text | |
InvalidFixity | |
InvalidKind Text | |
InvalidDataDeclType Text | |
InvalidKindSignatureFor Text | |
InvalidTime | |
InvalidRole Text |
Instances
Generic PackageError # | |
Defined in Language.PureScript.Docs.Types Associated Types type Rep PackageError :: Type -> Type # | |
Show PackageError # | |
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> PackageError -> ShowS # show :: PackageError -> String # showList :: [PackageError] -> ShowS # | |
NFData PackageError # | |
Defined in Language.PureScript.Docs.Types Methods rnf :: PackageError -> () # | |
Eq PackageError # | |
Defined in Language.PureScript.Docs.Types | |
Ord PackageError # | |
Defined in Language.PureScript.Docs.Types Methods compare :: PackageError -> PackageError -> Ordering # (<) :: PackageError -> PackageError -> Bool # (<=) :: PackageError -> PackageError -> Bool # (>) :: PackageError -> PackageError -> Bool # (>=) :: PackageError -> PackageError -> Bool # max :: PackageError -> PackageError -> PackageError # min :: PackageError -> PackageError -> PackageError # | |
type Rep PackageError # | |
Defined in Language.PureScript.Docs.Types type Rep PackageError = D1 ('MetaData "PackageError" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (((C1 ('MetaCons "CompilerTooOld" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :+: C1 ('MetaCons "ErrorInPackageMeta" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ManifestError))) :+: (C1 ('MetaCons "InvalidVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidDeclarationType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "InvalidChildDeclarationType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) :+: ((C1 ('MetaCons "InvalidFixity" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InvalidKind" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "InvalidDataDeclType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "InvalidKindSignatureFor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "InvalidTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidRole" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))) |
data ManifestError #
Constructors
BowerManifest BowerError | |
PursManifest PursJsonError |
Instances
Constructors
Package | |
Fields
|
Instances
FromJSON a => FromJSON (Package a) # | |
Defined in Language.PureScript.Docs.Types | |
ToJSON a => ToJSON (Package a) # | |
Generic (Package a) # | |
Show a => Show (Package a) # | |
NFData a => NFData (Package a) # | |
Defined in Language.PureScript.Docs.Types | |
Eq a => Eq (Package a) # | |
Ord a => Ord (Package a) # | |
type Rep (Package a) # | |
Defined in Language.PureScript.Docs.Types type Rep (Package a) = D1 ('MetaData "Package" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "Package" 'PrefixI 'True) (((S1 ('MetaSel ('Just "pkgMeta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageMeta) :*: S1 ('MetaSel ('Just "pkgVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)) :*: (S1 ('MetaSel ('Just "pkgVersionTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pkgTagTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)) :*: S1 ('MetaSel ('Just "pkgModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Module])))) :*: ((S1 ('MetaSel ('Just "pkgModuleMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ModuleName PackageName)) :*: S1 ('MetaSel ('Just "pkgResolvedDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(PackageName, Version)])) :*: (S1 ('MetaSel ('Just "pkgGithub") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GithubUser, GithubRepo)) :*: (S1 ('MetaSel ('Just "pkgUploader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "pkgCompilerVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version)))))) |
newtype GithubUser #
Constructors
GithubUser | |
Fields |
Instances
newtype GithubRepo #
Constructors
GithubRepo | |
Fields |
Instances
data NotYetKnown #
Constructors
NotYetKnown |
Instances
type UploadedPackage = Package NotYetKnown #
type VerifiedPackage = Package GithubUser #
data LinksContext #
Constructors
LinksContext | |
Fields
|
Instances
Generic LinksContext # | |
Defined in Language.PureScript.Docs.Types Associated Types type Rep LinksContext :: Type -> Type # | |
Show LinksContext # | |
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> LinksContext -> ShowS # show :: LinksContext -> String # showList :: [LinksContext] -> ShowS # | |
NFData LinksContext # | |
Defined in Language.PureScript.Docs.Types Methods rnf :: LinksContext -> () # | |
Eq LinksContext # | |
Defined in Language.PureScript.Docs.Types | |
Ord LinksContext # | |
Defined in Language.PureScript.Docs.Types Methods compare :: LinksContext -> LinksContext -> Ordering # (<) :: LinksContext -> LinksContext -> Bool # (<=) :: LinksContext -> LinksContext -> Bool # (>) :: LinksContext -> LinksContext -> Bool # (>=) :: LinksContext -> LinksContext -> Bool # max :: LinksContext -> LinksContext -> LinksContext # min :: LinksContext -> LinksContext -> LinksContext # | |
type Rep LinksContext # | |
Defined in Language.PureScript.Docs.Types type Rep LinksContext = D1 ('MetaData "LinksContext" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "LinksContext" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ctxGithub") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GithubUser, GithubRepo)) :*: (S1 ('MetaSel ('Just "ctxModuleMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ModuleName PackageName)) :*: S1 ('MetaSel ('Just "ctxResolvedDependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(PackageName, Version)]))) :*: (S1 ('MetaSel ('Just "ctxPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Just "ctxVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Just "ctxVersionTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) |
Constructors
DocLink | |
Fields |
Instances
Generic DocLink # | |
Show DocLink # | |
NFData DocLink # | |
Defined in Language.PureScript.Docs.Types | |
Eq DocLink # | |
Ord DocLink # | |
Defined in Language.PureScript.Docs.Types | |
type Rep DocLink # | |
Defined in Language.PureScript.Docs.Types type Rep DocLink = D1 ('MetaData "DocLink" "Language.PureScript.Docs.Types" "purescript-0.15.12-5l1zT9m1jq0GgrLEUvYibC" 'False) (C1 ('MetaCons "DocLink" 'PrefixI 'True) (S1 ('MetaSel ('Just "linkLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LinkLocation) :*: (S1 ('MetaSel ('Just "linkTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "linkNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Namespace)))) |
data LinkLocation #
Constructors
LocalModule ModuleName | A link to a declaration in the current package. |
DepsModule PackageName Version ModuleName | A link to a declaration in a different package. The arguments represent the name of the other package, the version of the other package, and the name of the module in the other package that the declaration is in. |
BuiltinModule ModuleName | A link to a declaration that is built in to the compiler, e.g. the Prim module. In this case we only need to store the module that the builtin comes from. Note that all builtin modules begin with Prim, and that the compiler rejects attempts to define modules whose names start with Prim. |
Instances
packageName :: Package a -> PackageName #
formatTime :: UTCTime -> String #
Convenience function for formatting a time in the format expected by this module.
parseTime :: String -> Maybe UTCTime #
Convenience function for parsing a time in the format expected by this module.
ignorePackage :: InPackage a -> a #
displayPackageError :: PackageError -> Text #
convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])] #
isType :: Declaration -> Bool #
isTypeClass :: Declaration -> Bool #
showManifestError :: ManifestError -> Text #
jsonTimeFormat :: String #
The time format used for serializing package tag times in the JSON format. This is the ISO 8601 date format which includes a time and a timezone.
declInfoToString :: DeclarationInfo -> Text #
isValue :: Declaration -> Bool #
isValueAlias :: Declaration -> Bool #
isTypeAlias :: Declaration -> Bool #
filterChildren :: (ChildDeclaration -> Bool) -> Declaration -> Declaration #
Discard any children which do not satisfy the given predicate.
getLink :: LinksContext -> ModuleName -> Namespace -> Text -> ContainingModule -> Maybe DocLink #
Given a links context, the current module name, the namespace of a thing to link to, its title, and its containing module, attempt to create a DocLink.
getLinksContext :: Package a -> LinksContext #
asVersion :: Parse PackageError Version #
parseTimeEither :: String -> Either PackageError UTCTime #
asResolvedDependencies :: Parse PackageError [(PackageName, Version)] #
asGithub :: Parse e (GithubUser, GithubRepo) #
asUploadedPackage :: Version -> Parse PackageError UploadedPackage #
asNotYetKnown :: Parse e NotYetKnown #
asGithubUser :: Parse e GithubUser #
asSourceSpan :: Parse e SourceSpan #
asInPackage :: Parse ManifestError a -> Parse ManifestError (InPackage a) #
parseAssociativity :: String -> Maybe Associativity #
asTypeArguments :: Parse PackageError [(Text, Maybe Type')] #
asRole :: Parse PackageError Role #
asSourcePos :: Parse e SourcePos #
asQualifiedProperName :: Parse e (Qualified (ProperName a)) #
assocListToJSON :: (a -> Key) -> (b -> Text) -> [(a, b)] -> Value #
Given a function for turning association list keys into JSON object keys, and a function for turning association list values to JSON string values, turns an association list into a JSON object.
For example:
assocListToJSON T.pack T.pack [("a", "b")]
will give {"a": "b"}
.
data RenderedCode #
A type representing a highly simplified version of PureScript code, intended for use in output formats like plain text or HTML.
Instances
data RenderedCodeElement #
A single element in a rendered code fragment. The intention is to support multiple output formats. For example, plain text, or highlighted HTML.
Constructors
Syntax Text | |
Keyword Text | |
Space | |
Symbol Namespace Text Link | Any symbol which you might or might not want to link to, in any namespace (value, type, or kind). Note that this is not related to the kind called Symbol for type-level strings. |
Role Text |
Instances
data ContainingModule #
This type is isomorphic to Maybe
ModuleName
. It makes code a bit
easier to read, as the meaning is more explicit.
Constructors
ThisModule | |
OtherModule ModuleName |
Instances
Constructors
ValueLevel | |
TypeLevel |
Instances
FromJSON Namespace # | |
Defined in Language.PureScript.Docs.RenderedCode.Types | |
ToJSON Namespace # | |
Generic Namespace # | |
Show Namespace # | |
NFData Namespace # | |
Defined in Language.PureScript.Docs.RenderedCode.Types | |
Eq Namespace # | |
Ord Namespace # | |
Defined in Language.PureScript.Docs.RenderedCode.Types | |
type Rep Namespace # | |
Defined in Language.PureScript.Docs.RenderedCode.Types |
type FixityAlias = Qualified (Either (ProperName 'TypeName) (Either Ident (ProperName 'ConstructorName))) #