Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.x7a6c33e2026-10-12Search packagesCtrl K

Theme: |

GHC 9.14.1 · lts/ghc-9.14.x · 7a6c33e · 2026-10-12

Modulehslua-typing-0.2.0Haskell2010

HsLua.Typing

The module provides Haskell types and values that can be used to describe and declare the types of Lua values.

Contents

Types
Built-in types
Type constructors
Marshalling

Synopsis

data TypeSpec
value #|#
value typeSpecToString
value typeSpecFromString
value anyType
value voidType
value booleanType
value functionType
value integerType
value lightUserdataType
value nilType
value numberType
value stringType
value tableType
value threadType
value userdataType
value recType
value seqType
value pushTypeSpec
value peekTypeSpec

Packagehslua-typing-0.2.0
Exports20
LanguageHaskell2010
LicenceMIT
SourceTyping.hs

datadata TypeSpec

Type specification for Lua values.

Constructors

BasicType Type
Built-in type
NamedType Name
A type that's been given a name.
SeqType TypeSpec
Sequence of the given type.
SumType [TypeSpec]
Union type; a sum type.
RecType (Map Name TypeSpec)
Record type (type product).
FunType [TypeSpec] [TypeSpec]
Function type.
AnyType
Unconstrained type.

Instances6Eq, Ord, Show, IsString, Generic, Rep

Eq TypeSpecDefined in hslua-typing-0.2.0 · HsLua.Typing
Ord TypeSpecDefined in hslua-typing-0.2.0 · HsLua.Typing
Show TypeSpecDefined in hslua-typing-0.2.0 · HsLua.Typing
IsString TypeSpecDefined in hslua-typing-0.2.0 · HsLua.Typing
For backwards compatibility and convenience, strings can be used as TypeSpec values.
Generic TypeSpecDefined in hslua-typing-0.2.0 · HsLua.Typing
type Rep TypeSpec = D1 ('MetaData "TypeSpec" "HsLua.Typing" "hslua-typing-0.2.0-B0djhG4O4MUCiBtiRqWj3p" 'False) ((C1 ('MetaCons "BasicType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Type)) :+: (C1 ('MetaCons "NamedType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)) :+: C1 ('MetaCons "SeqType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TypeSpec)))) :+: ((C1 ('MetaCons "SumType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "RecType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Name TypeSpec)))) :+: (C1 ('MetaCons "FunType" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec]) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TypeSpec])) :+: C1 ('MetaCons "AnyType" 'PrefixI 'False) U1)))Defined in hslua-typing-0.2.0 · HsLua.Typing

value(#|#) :: TypeSpec -> TypeSpec -> TypeSpec

Returns the sum of two type specifiers, declaring that a Lua value can have either type.

valuetypeSpecToString :: TypeSpec -> String

Generate a string representation of the type specifier.

valuetypeSpecFromString :: String -> TypeSpec

Creates a TypeSpec value from a string.

The implementation currently handles basic types, sequences, and alternatives. A string that cannot be parsed is returned as a Named type with the full string as the name.

Types

valueanyType :: TypeSpec

Unconstraint type; any Lua value.

valuevoidType :: TypeSpec

A type for which there cannot be any value.

Built-in types

valuebooleanType :: TypeSpec

The built-in boolean Lua type.

valuefunctionType :: TypeSpec

The built-in function Lua type.

valueintegerType :: TypeSpec

A Lua integer type.

valuelightUserdataType :: TypeSpec

The built-in light userdata Lua type.

valuenilType :: TypeSpec

The built-in nil Lua type.

valuenumberType :: TypeSpec

The built-in number Lua type.

valuestringType :: TypeSpec

The built-in string Lua type.

valuetableType :: TypeSpec

The built-in table Lua type.

valuethreadType :: TypeSpec

The built-in thread Lua type.

valueuserdataType :: TypeSpec

The built-in userdata Lua type.

Type constructors

valuerecType :: [(Name, TypeSpec)] -> TypeSpec

Creates a record type.

valueseqType :: TypeSpec -> TypeSpec

Creates a sequence type.

Marshalling

valuepushTypeSpec :: LuaError e => TypeSpec -> LuaE e ()

Pushes a table representation of a TypeSpec to the stack.

valuepeekTypeSpec :: LuaError e => Peeker e TypeSpec

Retrieves a TypeSpec from a table on the stack.