hslua-aeson-2.3.1: Allow aeson data types to be used with Lua.
Copyright© 2017-2024 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Safe HaskellNone
LanguageHaskell2010

HsLua.Aeson

Description

Pushes and retrieves aeson Values to and from the Lua stack.

  • JSON null values are encoded as light userdata containing the NULL pointer.
  • Objects are converted to string-indexed tables.
  • Arrays are converted to sequence tables and are given a metatable. This makes it possible to distinguish between empty arrays and empty objects. The metatable is stored in the registry under key 'HsLua JSON array'' (see also jsonarray).
  • JSON numbers are converted to Lua numbers, i.e., Number; the exact C type may vary, depending on compile-time Lua configuration.
Synopsis

Documentation

peekValue :: LuaError e => Peeker e Value #

Retrieves an Aeson Value from the Lua stack.

pushValue :: LuaError e => Pusher e Value #

Hslua StackValue instance for the Aeson Value data type.

peekViaJSON :: (FromJSON a, LuaError e) => Peeker e a #

Retrieves a value from the Lua stack via JSON.

pushViaJSON :: (ToJSON a, LuaError e) => Pusher e a #

Pushes a value to the Lua stack as a JSON-like value.

jsonarray :: Name #

Name of the registry slot holding the metatable given to array tables. The registry entry can be replaced with a different table if needed.

Encoding arbitrary objects

peekToAeson :: Peeker e (ToAeson e) #

Gets the ToAeson function from a Lua userdata object.

pushToAeson :: Pusher e (ToAeson e) #

Pushes a function that converts the object at a given index into a Value.