LuaString Struct Reference

Interop for a string in Lua. More...

#include <LuaString.h>

Public Member Functions
	LuaString ()
	Construct the string "".
void	read (lua_State *lua, int index)
	Read the string from stack index index.
bool	readField (lua_State *lua, const char *name)
	Read the string from a table field.
bool	readGlobal (lua_State *lua, const char *name)
	Read the string from a global table field.
bool	operator== (const std::string &rhs)
	operator std::string ()

Public Attributes
std::string	characters

Detailed Description

Interop for a string in Lua.

Constructor & Destructor Documentation

LuaString()

LuaString::LuaString ( )

inline

Construct the string "".

Member Function Documentation

operator std::string()

LuaString::operator std::string ( )

inline

operator==()

bool LuaString::operator== ( const std::string &  rhs )

inline

read()

void LuaString::read ( lua_State *  lua, int  index  )

inline

Read the string from stack index index.

Parameters

lua	the Lua context.
index	the stack index.

readField()

bool LuaString::readField ( lua_State *  lua, const char *  name  )

inline

Read the string from a table field.

Parameters

lua	the Lua context.
name	the field name.

Returns

true succesful read.

false unsuccesful read.

readGlobal()

bool LuaString::readGlobal ( lua_State *  lua, const char *  name  )

inline

Read the string from a global table field.

Parameters

lua	the Lua context.
name	the field name.

Returns

true succesful read.

false unsuccesful read.

Member Data Documentation

characters

std::string LuaString::characters

---

The documentation for this struct was generated from the following file:

• include/LuaString.h