Copyright | © 2020-2024 Albert Krewinkel |
---|---|
License | MIT |
Maintainer | Albert Krewinkel <tarleb@hslua.org> |
Stability | alpha |
Portability | Portable |
Safe Haskell | None |
Language | Haskell2010 |
HsLua.Packaging.Types
Description
Marshaling and documenting Haskell functions.
Synopsis
- data Module e = Module {
- moduleName :: Name
- moduleDescription :: Text
- moduleFields :: [Field e]
- moduleFunctions :: [DocumentedFunction e]
- moduleOperations :: [(Operation, DocumentedFunction e)]
- moduleTypeInitializers :: [LuaE e Name]
- data Field e = Field {
- fieldName :: Text
- fieldType :: TypeSpec
- fieldDescription :: Text
- fieldPushValue :: LuaE e ()
- data DocumentedFunction e = DocumentedFunction {}
- data FunctionDoc = FunctionDoc {}
- data ParameterDoc = ParameterDoc {}
- data ResultsDoc
- data ResultValueDoc = ResultValueDoc {}
Documented module
Named and documented Lua module.
Constructors
Module | |
Fields
|
Self-documenting module field
Constructors
Field | |
Fields
|
Documented functions
data DocumentedFunction e #
Haskell equivallent to CFunction, i.e., function callable from Lua.
Constructors
DocumentedFunction | |
Fields
|
Documentation types
data FunctionDoc #
Documentation for a Haskell function
Constructors
FunctionDoc | |
Fields
|
Instances
Show FunctionDoc # | |
Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> FunctionDoc -> ShowS # show :: FunctionDoc -> String # showList :: [FunctionDoc] -> ShowS # | |
Eq FunctionDoc # | |
Defined in HsLua.Packaging.Types | |
Ord FunctionDoc # | |
Defined in HsLua.Packaging.Types Methods compare :: FunctionDoc -> FunctionDoc -> Ordering # (<) :: FunctionDoc -> FunctionDoc -> Bool # (<=) :: FunctionDoc -> FunctionDoc -> Bool # (>) :: FunctionDoc -> FunctionDoc -> Bool # (>=) :: FunctionDoc -> FunctionDoc -> Bool # max :: FunctionDoc -> FunctionDoc -> FunctionDoc # min :: FunctionDoc -> FunctionDoc -> FunctionDoc # |
data ParameterDoc #
Documentation for function parameters.
Constructors
ParameterDoc | |
Fields |
Instances
Show ParameterDoc # | |
Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ParameterDoc -> ShowS # show :: ParameterDoc -> String # showList :: [ParameterDoc] -> ShowS # | |
Eq ParameterDoc # | |
Defined in HsLua.Packaging.Types | |
Ord ParameterDoc # | |
Defined in HsLua.Packaging.Types Methods compare :: ParameterDoc -> ParameterDoc -> Ordering # (<) :: ParameterDoc -> ParameterDoc -> Bool # (<=) :: ParameterDoc -> ParameterDoc -> Bool # (>) :: ParameterDoc -> ParameterDoc -> Bool # (>=) :: ParameterDoc -> ParameterDoc -> Bool # max :: ParameterDoc -> ParameterDoc -> ParameterDoc # min :: ParameterDoc -> ParameterDoc -> ParameterDoc # |
data ResultsDoc #
Documentation for the return values of a function.
Constructors
ResultsDocList [ResultValueDoc] | List of individual results |
ResultsDocMult Text | Flexible results |
Instances
Show ResultsDoc # | |
Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultsDoc -> ShowS # show :: ResultsDoc -> String # showList :: [ResultsDoc] -> ShowS # | |
Eq ResultsDoc # | |
Defined in HsLua.Packaging.Types | |
Ord ResultsDoc # | |
Defined in HsLua.Packaging.Types Methods compare :: ResultsDoc -> ResultsDoc -> Ordering # (<) :: ResultsDoc -> ResultsDoc -> Bool # (<=) :: ResultsDoc -> ResultsDoc -> Bool # (>) :: ResultsDoc -> ResultsDoc -> Bool # (>=) :: ResultsDoc -> ResultsDoc -> Bool # max :: ResultsDoc -> ResultsDoc -> ResultsDoc # min :: ResultsDoc -> ResultsDoc -> ResultsDoc # |
data ResultValueDoc #
Documentation for a single return value of a function.
Constructors
ResultValueDoc | |
Fields |
Instances
Show ResultValueDoc # | |
Defined in HsLua.Packaging.Types Methods showsPrec :: Int -> ResultValueDoc -> ShowS # show :: ResultValueDoc -> String # showList :: [ResultValueDoc] -> ShowS # | |
Eq ResultValueDoc # | |
Defined in HsLua.Packaging.Types Methods (==) :: ResultValueDoc -> ResultValueDoc -> Bool # (/=) :: ResultValueDoc -> ResultValueDoc -> Bool # | |
Ord ResultValueDoc # | |
Defined in HsLua.Packaging.Types Methods compare :: ResultValueDoc -> ResultValueDoc -> Ordering # (<) :: ResultValueDoc -> ResultValueDoc -> Bool # (<=) :: ResultValueDoc -> ResultValueDoc -> Bool # (>) :: ResultValueDoc -> ResultValueDoc -> Bool # (>=) :: ResultValueDoc -> ResultValueDoc -> Bool # max :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc # min :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc # |