Modulehslua-typing-0.1.1Haskell2010

HsLua.Typing

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

2 types
21 values

Packagehslua-typing-0.1.1
Exports23
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.1.1 · HsLua.Typing
Ord TypeSpecDefined in hslua-typing-0.1.1 · HsLua.Typing
Show TypeSpecDefined in hslua-typing-0.1.1 · HsLua.Typing
IsString TypeSpecDefined in hslua-typing-0.1.1 · HsLua.Typing
For backwards compatibility and convenience, strings can be used as TypeSpec values.
Generic TypeSpecDefined in hslua-typing-0.1.1 · HsLua.Typing
type Rep TypeSpec = D1 ('MetaData "TypeSpec" "HsLua.Typing" "hslua-typing-0.1.1-FzWs0VLRKtl5YEKUCempa9" '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.1.1 · HsLua.Typing

datadata TypeDocs

Documented custom type.

Constructors

TypeDocs
- typeDescription :: Text
- typeSpec :: TypeSpec
- typeRegistry :: Maybe Name

Instances5Eq, Ord, Show, Generic, Rep

Eq TypeDocsDefined in hslua-typing-0.1.1 · HsLua.Typing
Ord TypeDocsDefined in hslua-typing-0.1.1 · HsLua.Typing
Show TypeDocsDefined in hslua-typing-0.1.1 · HsLua.Typing
Generic TypeDocsDefined in hslua-typing-0.1.1 · HsLua.Typing
type Rep TypeDocs = D1 ('MetaData "TypeDocs" "HsLua.Typing" "hslua-typing-0.1.1-FzWs0VLRKtl5YEKUCempa9" 'False) (C1 ('MetaCons "TypeDocs" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "typeSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TypeSpec) :*: S1 ('MetaSel ('Just "typeRegistry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Name)))))Defined in hslua-typing-0.1.1 · 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

2 declarations

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

4 declarations

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.

valuepushTypeDoc :: LuaError e => Pusher e TypeDocs

Pushes documentation for a custom type.

valuepeekTypeDoc :: LuaError e => Peeker e TypeDocs

Retrieves a custom type specifier.