Modulehslua-classes-2.3.2Haskell2010

HsLua.Class.Util

HsLua utility functions.

Contents

getting values

Synopsis

value raiseError
newtype Optional
value peekEither
value popValue

Packagehslua-classes-2.3.2
Exports4
LanguageHaskell2010
LicenceMIT
SourceUtil.hs

valueraiseError :: (LuaError e, Pushable a) => a -> LuaE e NumResults

Source#

Raise a Lua error, using the given value as the error object.

newtypenewtype Optional a

Source#

Newtype wrapper intended to be used for optional Lua values. Nesting this type is strongly discouraged as missing values on inner levels are indistinguishable from missing values on an outer level; wrong values would be the likely result.

Constructors

Optional
- fromOptional :: Maybe a

Instances2Peekable, Pushable

Peekable a => Peekable (Optional a)Defined in hslua-classes-2.3.2 · HsLua.Class.Util
Pushable a => Pushable (Optional a)Defined in hslua-classes-2.3.2 · HsLua.Class.Util

getting values

valuepeekEither :: (LuaError e, Peekable a) => StackIndex -> LuaE e (Either e a)

Source#

Try to convert the value at the given stack index to a Haskell value. Returns Left with the error on failure.

valuepopValue :: (LuaError e, Peekable a) => LuaE e a

Source#

Get, then pop the value at the top of the stack. The pop operation is executed even if the retrieval operation failed.