hslua-packaging-2.1.0: Utilities to build Lua modules.
Copyright© 2021-2022 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb+hslua@zeitkraut.de>
Safe HaskellNone
LanguageHaskell2010

HsLua.Packaging.Convenience

Description

Convenience functions for common parameter and result types.

Synopsis

Parameters

boolParam Source #

Arguments

:: Text

parameter name

-> Text

parameter description

-> Parameter e Bool 

Defines a function parameter of type Bool.

integralParam Source #

Arguments

:: (Read a, Integral a) 
=> Text

parameter name

-> Text

parameter description

-> Parameter e a 

Defines a function parameter for an integral type.

stringParam Source #

Arguments

:: Text

parameter name

-> Text

parameter description

-> Parameter e String 

Defines a function parameter of type String.

textParam Source #

Arguments

:: Text

parameter name

-> Text

parameter description

-> Parameter e Text 

Defines a function parameter of type Text.

Results

boolResult Source #

Arguments

:: Text

result description

-> FunctionResults e Bool 

Defines a function result of type Bool.

integralResult Source #

Arguments

:: (Integral a, Show a) 
=> Text

result description

-> FunctionResults e a 

Defines a function result for an integral type.

stringResult Source #

Arguments

:: Text

result description

-> FunctionResults e String 

Defines a function result of type Text.

textResult Source #

Arguments

:: Text

result description

-> FunctionResults e Text 

Defines a function result of type Text.