HsLua.Marshalling.Push

Functions which marshal and push Haskell values onto Lua's stack.

Documentation

type Pusher e a = a -> LuaE e ()

Function to push a value to Lua's stack.

Primitives

pushBool :: Pusher e Bool

Pushes a Bool as a Lua boolean.

pushIntegral :: (Integral a, Show a) => a -> LuaE e ()

Pushes an Integer to the Lua stack. Values representable as Lua integers are pushed as such; bigger integers are represented using their string representation.

pushRealFloat :: RealFloat a => a -> LuaE e ()

Push a floating point number to the Lua stack. Uses a string representation for all types which do not match the float properties of the Number type.

Strings

pushByteString :: Pusher e ByteString

Pushes a ByteString as a raw string.

pushLazyByteString :: Pusher e ByteString

Pushes a lazy ByteString as a raw string.

pushString :: String -> LuaE e ()

Pushes a String as a UTF-8 encoded Lua string.

pushText :: Pusher e Text

Pushes a Text value as a UTF-8 encoded string.

pushName :: Name -> LuaE e ()

Pushes a Name as a UTF-8 encoded Lua string.

Collections

pushList :: LuaError e => Pusher e a -> [a] -> LuaE e ()

Push list as numerically indexed table.

pushKeyValuePairs :: LuaError e => Pusher e a -> Pusher e b -> Pusher e [(a, b)]

Push list of pairs as default key-value Lua table.

pushMap :: LuaError e => Pusher e a -> Pusher e b -> Pusher e (Map a b)

Push Map as default key-value Lua table.

pushSet :: LuaError e => Pusher e a -> Pusher e (Set a)

Push a Set as idiomatic Lua set, i.e., as a table with the set elements as keys and true as values.

Combinators

pushPair :: LuaError e => Pusher e a -> Pusher e b -> (a, b) -> LuaE e ()

Pushes a pair of values as a two element list.

pushTriple :: LuaError e => Pusher e a -> Pusher e b -> Pusher e c -> (a, b, c) -> LuaE e ()

Pushes a value triple as a three element list.

pushAsTable :: LuaError e => [(Name, a -> LuaE e ())] -> a -> LuaE e ()

Pushes an object as a table, defined by a list of field-names/push-function pairs.