Safe Haskell | None |
---|---|
Language | Haskell2010 |
Language.PureScript.Docs.Types
Synopsis
- data Module = Module {
- modName :: ModuleName
- modComments :: Maybe Text
- modDeclarations :: [Declaration]
- modReExports :: [(InPackage ModuleName, [Declaration])]
- packageName :: Package a -> PackageName
- data Package a = Package {}
- formatTime :: UTCTime -> String
- parseTime :: String -> Maybe UTCTime
- data Declaration = Declaration {}
- data ChildDeclaration = ChildDeclaration {}
- data ChildDeclarationInfo
- ignorePackage :: InPackage a -> a
- data InPackage a
- = Local a
- | FromDep PackageName a
- asModule :: Parse PackageError Module
- displayPackageError :: PackageError -> Text
- 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 ()
- convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])]
- isType :: Declaration -> Bool
- isTypeClass :: Declaration -> Bool
- type Constraint' = Constraint ()
- isTypeClassMember :: ChildDeclaration -> Bool
- kindSignatureForKeyword :: KindSignatureFor -> Text
- data PackageError
- data ManifestError
- showManifestError :: ManifestError -> Text
- newtype GithubUser = GithubUser {}
- newtype GithubRepo = GithubRepo {}
- data NotYetKnown = NotYetKnown
- type UploadedPackage = Package NotYetKnown
- type VerifiedPackage = Package GithubUser
- 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
- data LinksContext = LinksContext {}
- data DocLink = DocLink {}
- data LinkLocation
- 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 :: forall e (a :: ProperNameType). Parse e (Qualified (ProperName a))
- parsePackageName' :: Text -> Either PackageError PackageName
- assocListToJSON :: (a -> Key) -> (b -> Text) -> [(a, b)] -> Value
- data RenderedCodeElement
- data RenderedCode
- data ContainingModule
- asContainingModule :: Parse Text ContainingModule
- data Namespace
- type FixityAlias = Qualified (Either (ProperName 'TypeName) (Either Ident (ProperName 'ConstructorName)))
Documentation
Constructors
Module | |
Fields
|
Instances
packageName :: Package a -> PackageName #
Constructors
Package | |
Fields
|
Instances
FromJSON a => FromJSON (Package a) # | |||||
Defined in Language.PureScript.Docs.Types | |||||
ToJSON a => ToJSON (Package a) # | |||||
NFData a => NFData (Package a) # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Generic (Package a) # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show a => Show (Package a) # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" '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)))))) |
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.
data Declaration #
Constructors
Declaration | |
Fields
|
Instances
ToJSON Declaration # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: Declaration -> Value # toEncoding :: Declaration -> Encoding # toJSONList :: [Declaration] -> Value # toEncodingList :: [Declaration] -> Encoding # omitField :: Declaration -> Bool # | |||||
NFData Declaration # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: Declaration -> () # | |||||
Generic Declaration # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show Declaration # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS # | |||||
Eq Declaration # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Ord Declaration # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: Declaration -> Declaration -> Ordering # (<) :: Declaration -> Declaration -> Bool # (<=) :: Declaration -> Declaration -> Bool # (>) :: Declaration -> Declaration -> Bool # (>=) :: Declaration -> Declaration -> Bool # max :: Declaration -> Declaration -> Declaration # min :: Declaration -> Declaration -> Declaration # | |||||
type Rep Declaration # | |||||
Defined in Language.PureScript.Docs.Types type Rep Declaration = D1 ('MetaData "Declaration" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "Declaration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "declTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "declComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "declSourceSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SourceSpan)))) :*: (S1 ('MetaSel ('Just "declChildren") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ChildDeclaration]) :*: (S1 ('MetaSel ('Just "declInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeclarationInfo) :*: S1 ('MetaSel ('Just "declKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe KindInfo)))))) |
data ChildDeclaration #
Constructors
ChildDeclaration | |
Fields |
Instances
ToJSON ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: ChildDeclaration -> Value # toEncoding :: ChildDeclaration -> Encoding # toJSONList :: [ChildDeclaration] -> Value # toEncodingList :: [ChildDeclaration] -> Encoding # omitField :: ChildDeclaration -> Bool # | |||||
NFData ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: ChildDeclaration -> () # | |||||
Generic ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
Methods from :: ChildDeclaration -> Rep ChildDeclaration x # to :: Rep ChildDeclaration x -> ChildDeclaration # | |||||
Show ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ChildDeclaration -> ShowS # show :: ChildDeclaration -> String # showList :: [ChildDeclaration] -> ShowS # | |||||
Eq ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Methods (==) :: ChildDeclaration -> ChildDeclaration -> Bool # (/=) :: ChildDeclaration -> ChildDeclaration -> Bool # | |||||
Ord ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: ChildDeclaration -> ChildDeclaration -> Ordering # (<) :: ChildDeclaration -> ChildDeclaration -> Bool # (<=) :: ChildDeclaration -> ChildDeclaration -> Bool # (>) :: ChildDeclaration -> ChildDeclaration -> Bool # (>=) :: ChildDeclaration -> ChildDeclaration -> Bool # max :: ChildDeclaration -> ChildDeclaration -> ChildDeclaration # min :: ChildDeclaration -> ChildDeclaration -> ChildDeclaration # | |||||
type Rep ChildDeclaration # | |||||
Defined in Language.PureScript.Docs.Types type Rep ChildDeclaration = D1 ('MetaData "ChildDeclaration" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ChildDeclaration" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cdeclTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "cdeclComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cdeclSourceSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SourceSpan)) :*: S1 ('MetaSel ('Just "cdeclInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChildDeclarationInfo)))) |
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
ToJSON ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: ChildDeclarationInfo -> Value # toEncoding :: ChildDeclarationInfo -> Encoding # toJSONList :: [ChildDeclarationInfo] -> Value # toEncodingList :: [ChildDeclarationInfo] -> Encoding # omitField :: ChildDeclarationInfo -> Bool # | |||||
NFData ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: ChildDeclarationInfo -> () # | |||||
Generic ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
Methods from :: ChildDeclarationInfo -> Rep ChildDeclarationInfo x # to :: Rep ChildDeclarationInfo x -> ChildDeclarationInfo # | |||||
Show ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ChildDeclarationInfo -> ShowS # show :: ChildDeclarationInfo -> String # showList :: [ChildDeclarationInfo] -> ShowS # | |||||
Eq ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods (==) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # (/=) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # | |||||
Ord ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: ChildDeclarationInfo -> ChildDeclarationInfo -> Ordering # (<) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # (<=) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # (>) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # (>=) :: ChildDeclarationInfo -> ChildDeclarationInfo -> Bool # max :: ChildDeclarationInfo -> ChildDeclarationInfo -> ChildDeclarationInfo # min :: ChildDeclarationInfo -> ChildDeclarationInfo -> ChildDeclarationInfo # | |||||
type Rep ChildDeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types type Rep ChildDeclarationInfo = D1 ('MetaData "ChildDeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ChildInstance" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Constraint']) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "ChildDataConstructor" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Type'])) :+: C1 ('MetaCons "ChildTypeClassMember" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')))) |
ignorePackage :: InPackage a -> a #
Constructors
Local a | |
FromDep PackageName a |
Instances
Functor InPackage # | |||||
ToJSON a => ToJSON (InPackage a) # | |||||
NFData a => NFData (InPackage a) # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Generic (InPackage a) # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show a => Show (InPackage a) # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" '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))) |
displayPackageError :: PackageError -> Text #
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
ToJSON DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: DeclarationInfo -> Value # toEncoding :: DeclarationInfo -> Encoding # toJSONList :: [DeclarationInfo] -> Value # toEncodingList :: [DeclarationInfo] -> Encoding # omitField :: DeclarationInfo -> Bool # | |||||
NFData DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: DeclarationInfo -> () # | |||||
Generic DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
Methods from :: DeclarationInfo -> Rep DeclarationInfo x # to :: Rep DeclarationInfo x -> DeclarationInfo # | |||||
Show DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> DeclarationInfo -> ShowS # show :: DeclarationInfo -> String # showList :: [DeclarationInfo] -> ShowS # | |||||
Eq DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods (==) :: DeclarationInfo -> DeclarationInfo -> Bool # (/=) :: DeclarationInfo -> DeclarationInfo -> Bool # | |||||
Ord DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: DeclarationInfo -> DeclarationInfo -> Ordering # (<) :: DeclarationInfo -> DeclarationInfo -> Bool # (<=) :: DeclarationInfo -> DeclarationInfo -> Bool # (>) :: DeclarationInfo -> DeclarationInfo -> Bool # (>=) :: DeclarationInfo -> DeclarationInfo -> Bool # max :: DeclarationInfo -> DeclarationInfo -> DeclarationInfo # min :: DeclarationInfo -> DeclarationInfo -> DeclarationInfo # | |||||
type Rep DeclarationInfo # | |||||
Defined in Language.PureScript.Docs.Types type Rep DeclarationInfo = D1 ('MetaData "DeclarationInfo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) ((C1 ('MetaCons "ValueDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "DataDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DataDeclType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Role]))) :+: C1 ('MetaCons "ExternDataDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type') :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Role])))) :+: (C1 ('MetaCons "TypeSynonymDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type')) :+: (C1 ('MetaCons "TypeClassDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Text, Maybe Type')]) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Constraint']) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [([Text], [Text])]))) :+: C1 ('MetaCons "AliasDeclaration" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Fixity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FixityAlias))))) |
Wraps enough information to properly render the kind signature of a datanewtypetype/class declaration.
Constructors
KindInfo | |
Fields
|
Instances
ToJSON KindInfo # | |||||
NFData KindInfo # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Generic KindInfo # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show KindInfo # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "KindInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kiKeyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 KindSignatureFor) :*: S1 ('MetaSel ('Just "kiKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type'))) |
convertFundepsToStrings :: [(Text, Maybe Type')] -> [FunctionalDependency] -> [([Text], [Text])] #
isType :: Declaration -> Bool #
isTypeClass :: Declaration -> Bool #
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
NFData PackageError # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: PackageError -> () # | |||||
Generic PackageError # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show PackageError # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> PackageError -> ShowS # show :: PackageError -> String # showList :: [PackageError] -> ShowS # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" '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
NFData ManifestError # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: ManifestError -> () # | |||||
Generic ManifestError # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show ManifestError # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> ManifestError -> ShowS # show :: ManifestError -> String # showList :: [ManifestError] -> ShowS # | |||||
Eq ManifestError # | |||||
Defined in Language.PureScript.Docs.Types Methods (==) :: ManifestError -> ManifestError -> Bool # (/=) :: ManifestError -> ManifestError -> Bool # | |||||
Ord ManifestError # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: ManifestError -> ManifestError -> Ordering # (<) :: ManifestError -> ManifestError -> Bool # (<=) :: ManifestError -> ManifestError -> Bool # (>) :: ManifestError -> ManifestError -> Bool # (>=) :: ManifestError -> ManifestError -> Bool # max :: ManifestError -> ManifestError -> ManifestError # min :: ManifestError -> ManifestError -> ManifestError # | |||||
type Rep ManifestError # | |||||
Defined in Language.PureScript.Docs.Types type Rep ManifestError = D1 ('MetaData "ManifestError" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "BowerManifest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BowerError)) :+: C1 ('MetaCons "PursManifest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PursJsonError))) |
showManifestError :: ManifestError -> Text #
newtype GithubUser #
Constructors
GithubUser | |
Fields |
Instances
FromJSON GithubUser # | |||||
Defined in Language.PureScript.Docs.Types | |||||
ToJSON GithubUser # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: GithubUser -> Value # toEncoding :: GithubUser -> Encoding # toJSONList :: [GithubUser] -> Value # toEncodingList :: [GithubUser] -> Encoding # omitField :: GithubUser -> Bool # | |||||
NFData GithubUser # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: GithubUser -> () # | |||||
Generic GithubUser # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show GithubUser # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> GithubUser -> ShowS # show :: GithubUser -> String # showList :: [GithubUser] -> ShowS # | |||||
Eq GithubUser # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Ord GithubUser # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: GithubUser -> GithubUser -> Ordering # (<) :: GithubUser -> GithubUser -> Bool # (<=) :: GithubUser -> GithubUser -> Bool # (>) :: GithubUser -> GithubUser -> Bool # (>=) :: GithubUser -> GithubUser -> Bool # max :: GithubUser -> GithubUser -> GithubUser # min :: GithubUser -> GithubUser -> GithubUser # | |||||
type Rep GithubUser # | |||||
Defined in Language.PureScript.Docs.Types type Rep GithubUser = D1 ('MetaData "GithubUser" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'True) (C1 ('MetaCons "GithubUser" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
newtype GithubRepo #
Constructors
GithubRepo | |
Fields |
Instances
ToJSON GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: GithubRepo -> Value # toEncoding :: GithubRepo -> Encoding # toJSONList :: [GithubRepo] -> Value # toEncodingList :: [GithubRepo] -> Encoding # omitField :: GithubRepo -> Bool # | |||||
NFData GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: GithubRepo -> () # | |||||
Generic GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> GithubRepo -> ShowS # show :: GithubRepo -> String # showList :: [GithubRepo] -> ShowS # | |||||
Eq GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Ord GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: GithubRepo -> GithubRepo -> Ordering # (<) :: GithubRepo -> GithubRepo -> Bool # (<=) :: GithubRepo -> GithubRepo -> Bool # (>) :: GithubRepo -> GithubRepo -> Bool # (>=) :: GithubRepo -> GithubRepo -> Bool # max :: GithubRepo -> GithubRepo -> GithubRepo # min :: GithubRepo -> GithubRepo -> GithubRepo # | |||||
type Rep GithubRepo # | |||||
Defined in Language.PureScript.Docs.Types type Rep GithubRepo = D1 ('MetaData "GithubRepo" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'True) (C1 ('MetaCons "GithubRepo" 'PrefixI 'True) (S1 ('MetaSel ('Just "runGithubRepo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
data NotYetKnown #
Constructors
NotYetKnown |
Instances
FromJSON NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types | |||||
ToJSON NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types Methods toJSON :: NotYetKnown -> Value # toEncoding :: NotYetKnown -> Encoding # toJSONList :: [NotYetKnown] -> Value # toEncodingList :: [NotYetKnown] -> Encoding # omitField :: NotYetKnown -> Bool # | |||||
NFData NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: NotYetKnown -> () # | |||||
Generic NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> NotYetKnown -> ShowS # show :: NotYetKnown -> String # showList :: [NotYetKnown] -> ShowS # | |||||
Eq NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Ord NotYetKnown # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: NotYetKnown -> NotYetKnown -> Ordering # (<) :: NotYetKnown -> NotYetKnown -> Bool # (<=) :: NotYetKnown -> NotYetKnown -> Bool # (>) :: NotYetKnown -> NotYetKnown -> Bool # (>=) :: NotYetKnown -> NotYetKnown -> Bool # max :: NotYetKnown -> NotYetKnown -> NotYetKnown # min :: NotYetKnown -> NotYetKnown -> NotYetKnown # | |||||
type Rep NotYetKnown # | |||||
type UploadedPackage = Package NotYetKnown #
type VerifiedPackage = Package GithubUser #
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.
data LinksContext #
Constructors
LinksContext | |
Fields |
Instances
NFData LinksContext # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: LinksContext -> () # | |||||
Generic LinksContext # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show LinksContext # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> LinksContext -> ShowS # show :: LinksContext -> String # showList :: [LinksContext] -> ShowS # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" '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
NFData DocLink # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Generic DocLink # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show DocLink # | |||||
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.15-8K0LbmS63k4ILju2RsIrDp" '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
NFData LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types Methods rnf :: LinkLocation -> () # | |||||
Generic LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types Associated Types
| |||||
Show LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types Methods showsPrec :: Int -> LinkLocation -> ShowS # show :: LinkLocation -> String # showList :: [LinkLocation] -> ShowS # | |||||
Eq LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types | |||||
Ord LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types Methods compare :: LinkLocation -> LinkLocation -> Ordering # (<) :: LinkLocation -> LinkLocation -> Bool # (<=) :: LinkLocation -> LinkLocation -> Bool # (>) :: LinkLocation -> LinkLocation -> Bool # (>=) :: LinkLocation -> LinkLocation -> Bool # max :: LinkLocation -> LinkLocation -> LinkLocation # min :: LinkLocation -> LinkLocation -> LinkLocation # | |||||
type Rep LinkLocation # | |||||
Defined in Language.PureScript.Docs.Types type Rep LinkLocation = D1 ('MetaData "LinkLocation" "Language.PureScript.Docs.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "LocalModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: (C1 ('MetaCons "DepsModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName))) :+: C1 ('MetaCons "BuiltinModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)))) |
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 #
asGithub :: Parse e (GithubUser, GithubRepo) #
asNotYetKnown :: Parse e NotYetKnown #
asGithubUser :: Parse e GithubUser #
asSourceSpan :: Parse e SourceSpan #
asInPackage :: Parse ManifestError a -> Parse ManifestError (InPackage a) #
asTypeArguments :: Parse PackageError [(Text, Maybe Type')] #
asRole :: Parse PackageError Role #
asSourcePos :: Parse e SourcePos #
asQualifiedProperName :: forall e (a :: ProperNameType). 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 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
ToJSON RenderedCodeElement # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: RenderedCodeElement -> Value # toEncoding :: RenderedCodeElement -> Encoding # toJSONList :: [RenderedCodeElement] -> Value # toEncodingList :: [RenderedCodeElement] -> Encoding # omitField :: RenderedCodeElement -> Bool # | |
Show RenderedCodeElement # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> RenderedCodeElement -> ShowS # show :: RenderedCodeElement -> String # showList :: [RenderedCodeElement] -> ShowS # | |
Eq RenderedCodeElement # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (/=) :: RenderedCodeElement -> RenderedCodeElement -> Bool # | |
Ord RenderedCodeElement # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: RenderedCodeElement -> RenderedCodeElement -> Ordering # (<) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (<=) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (>) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (>=) :: RenderedCodeElement -> RenderedCodeElement -> Bool # max :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement # min :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement # |
data RenderedCode #
A type representing a highly simplified version of PureScript code, intended for use in output formats like plain text or HTML.
Instances
ToJSON RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: RenderedCode -> Value # toEncoding :: RenderedCode -> Encoding # toJSONList :: [RenderedCode] -> Value # toEncodingList :: [RenderedCode] -> Encoding # omitField :: RenderedCode -> Bool # | |
Monoid RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods mempty :: RenderedCode # mappend :: RenderedCode -> RenderedCode -> RenderedCode # mconcat :: [RenderedCode] -> RenderedCode # | |
Semigroup RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods (<>) :: RenderedCode -> RenderedCode -> RenderedCode # sconcat :: NonEmpty RenderedCode -> RenderedCode # stimes :: Integral b => b -> RenderedCode -> RenderedCode # | |
Show RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> RenderedCode -> ShowS # show :: RenderedCode -> String # showList :: [RenderedCode] -> ShowS # | |
Eq RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types | |
Ord RenderedCode # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: RenderedCode -> RenderedCode -> Ordering # (<) :: RenderedCode -> RenderedCode -> Bool # (<=) :: RenderedCode -> RenderedCode -> Bool # (>) :: RenderedCode -> RenderedCode -> Bool # (>=) :: RenderedCode -> RenderedCode -> Bool # max :: RenderedCode -> RenderedCode -> RenderedCode # min :: RenderedCode -> RenderedCode -> RenderedCode # |
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
FromJSON ContainingModule # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser ContainingModule # parseJSONList :: Value -> Parser [ContainingModule] # | |
ToJSON ContainingModule # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: ContainingModule -> Value # toEncoding :: ContainingModule -> Encoding # toJSONList :: [ContainingModule] -> Value # toEncodingList :: [ContainingModule] -> Encoding # omitField :: ContainingModule -> Bool # | |
Show ContainingModule # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> ContainingModule -> ShowS # show :: ContainingModule -> String # showList :: [ContainingModule] -> ShowS # | |
Eq ContainingModule # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: ContainingModule -> ContainingModule -> Bool # (/=) :: ContainingModule -> ContainingModule -> Bool # | |
Ord ContainingModule # | |
Defined in Language.PureScript.Docs.RenderedCode.Types Methods compare :: ContainingModule -> ContainingModule -> Ordering # (<) :: ContainingModule -> ContainingModule -> Bool # (<=) :: ContainingModule -> ContainingModule -> Bool # (>) :: ContainingModule -> ContainingModule -> Bool # (>=) :: ContainingModule -> ContainingModule -> Bool # max :: ContainingModule -> ContainingModule -> ContainingModule # min :: ContainingModule -> ContainingModule -> ContainingModule # |
Constructors
ValueLevel | |
TypeLevel |
Instances
FromJSON Namespace # | |||||
Defined in Language.PureScript.Docs.RenderedCode.Types | |||||
ToJSON Namespace # | |||||
NFData Namespace # | |||||
Defined in Language.PureScript.Docs.RenderedCode.Types | |||||
Generic Namespace # | |||||
Defined in Language.PureScript.Docs.RenderedCode.Types Associated Types
| |||||
Show Namespace # | |||||
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))) #