Copyright	© 2007–2012 Gracjan Polak 2012–2016 Ömer Sinan Ağacan 2017-2020 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb+hslua@zeitkraut.de>
Stability	beta
Portability	non-portable (depends on GHC)
Safe Haskell	None
Language	Haskell2010

Foreign.Lua.Types.Peekable

Description

Sending haskell objects to the lua stack.

Synopsis

class Peekable a where
- peek :: StackIndex -> Lua a
peekKeyValuePairs :: (Peekable a, Peekable b) => StackIndex -> Lua [(a, b)]
peekList :: Peekable a => StackIndex -> Lua [a]
reportValueOnFailure :: String -> (StackIndex -> Lua (Maybe a)) -> StackIndex -> Lua a

Documentation

class Peekable a where Source #

A value that can be read from the Lua stack.

Methods

peek :: StackIndex -> Lua a Source #

Check if at index n there is a convertible Lua value and if so return it. Throws a Exception otherwise.

Instances

Peekable Bool Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Bool Source #
Peekable Double Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Double Source #
Peekable Float Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Float Source #
Peekable Int Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Int Source #
Peekable Integer Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Integer Source #
Peekable () Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua () Source #
Peekable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua ByteString Source #
Peekable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua ByteString Source #
Peekable Text Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Text Source #
Peekable Number Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Number Source #
Peekable Integer Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Integer Source #
Peekable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua CFunction Source #
Peekable State Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua State Source #
Peekable [Char] Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua [Char] Source #
Peekable a => Peekable [a] Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua [a] Source #
Peekable (Ptr a) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Ptr a) Source #
(Ord a, Peekable a) => Peekable (Set a) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Set a) Source #
Peekable a => Peekable (Optional a) Source #
Instance details Defined in Foreign.Lua.Util Methods peek :: StackIndex -> Lua (Optional a) Source #
(Peekable a, Peekable b) => Peekable (a, b) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b) Source #
(Ord a, Peekable a, Peekable b) => Peekable (Map a b) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Map a b) Source #
(Peekable a, Peekable b, Peekable c) => Peekable (a, b, c) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c) Source #
(Peekable a, Peekable b, Peekable c, Peekable d) => Peekable (a, b, c, d) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e) => Peekable (a, b, c, d, e) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f) => Peekable (a, b, c, d, e, f) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g) => Peekable (a, b, c, d, e, f, g) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f, g) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g, Peekable h) => Peekable (a, b, c, d, e, f, g, h) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f, g, h) Source #

peekKeyValuePairs :: (Peekable a, Peekable b) => StackIndex -> Lua [(a, b)] Source #

Read a table into a list of pairs.

peekList :: Peekable a => StackIndex -> Lua [a] Source #

Read a table into a list

reportValueOnFailure :: String -> (StackIndex -> Lua (Maybe a)) -> StackIndex -> Lua a Source #

Report the expected and actual type of the value under the given index if conversion failed.