HsLua.Class.Util

HsLua utility functions.

Documentation

raiseError :: (PeekError e, Pushable a) => a -> LuaE e NumResults

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

newtype Optional a

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

Fields

• fromOptional :: Maybe a

Instances

Peekable a => Peekable (Optional a)

Defined in HsLua.Class.Util

Methods

peek :: PeekError e => StackIndex -> LuaE e (Optional a)

Pushable a => Pushable (Optional a)

Defined in HsLua.Class.Util

Methods

push :: LuaError e => Optional a -> LuaE e ()

getting values

peekEither :: (PeekError e, Peekable a) => StackIndex -> LuaE e (Either e a)

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

popValue :: (PeekError e, Peekable a) => LuaE e a

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