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

HsLua.Class.Peekable

Description

Sending haskell objects to the lua stack.

Synopsis

class Peekable a where
- safepeek :: LuaError e => Peeker e a
peek :: forall a e. (LuaError e, Peekable a) => StackIndex -> LuaE e a

Documentation

class Peekable a where Source #

A value that can be read from the Lua stack.

Methods

safepeek :: LuaError e => Peeker e a Source #

Function that retrieves a value from the Lua stack.

Instances

Instances details

Peekable ByteString Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e ByteString Source #
Peekable ByteString Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e ByteString Source #
Peekable CFunction Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e CFunction Source #
Peekable Integer Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Integer Source #
Peekable Number Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Number Source #
Peekable State Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e State Source #
Peekable Text Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Text Source #
Peekable Integer Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Integer Source #
Peekable () Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e () Source #
Peekable Bool Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Bool Source #
Peekable Double Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Double Source #
Peekable Float Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Float Source #
Peekable Int Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e Int Source #
Peekable (Ptr a) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Ptr a) Source #
(Ord a, Peekable a) => Peekable (Set a) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Set a) Source #
Peekable a => Peekable (Optional a) Source #
Instance details Defined in HsLua.Class.Util Methods safepeek :: LuaError e => Peeker e (Optional a) Source #
Peekable [Char] Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e [Char] Source #
Peekable a => Peekable [a] Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e [a] Source #
(Ord a, Peekable a, Peekable b) => Peekable (Map a b) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (Map a b) Source #
(Peekable a, Peekable b) => Peekable (a, b) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (a, b) Source #
(Peekable a, Peekable b, Peekable c) => Peekable (a, b, c) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (a, b, c) Source #
(Peekable a, Peekable b, Peekable c, Peekable d) => Peekable (a, b, c, d) Source #
Instance details Defined in HsLua.Class.Peekable Methods safepeek :: LuaError e => Peeker e (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 HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (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 HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (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 HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (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 HsLua.Class.Peekable Methods safepeek :: LuaError e0 => Peeker e0 (a, b, c, d, e, f, g, h) Source #

peek :: forall a e. (LuaError e, Peekable a) => StackIndex -> LuaE e a Source #

Retrieves a Peekable value from the stack. Throws an exception of type e if the given stack index does not a suitable value.