README
¶
===============================================================================
gluamapper: maps a GopherLua table to a Go struct
===============================================================================
.. image:: https://godoc.org/github.com/yuin/gluamapper?status.svg
:target: http://godoc.org/github.com/yuin/gluamapper
.. image:: https://travis-ci.org/yuin/gluamapper.svg
:target: https://travis-ci.org/yuin/gluamapper
|
gluamapper provides an easy way to map GopherLua tables to Go structs.
gluamapper converts a GopherLua table to ``map[string]interface{}`` , and then converts it to a Go struct using `mapstructure <https://github.com/mitchellh/mapstructure/>`_ .
----------------------------------------------------------------
Installation
----------------------------------------------------------------
.. code-block:: bash
go get github.com/yuin/gluamapper
----------------------------------------------------------------
API
----------------------------------------------------------------
See `Go doc <http://godoc.org/github.com/yuin/gluamapper>`_ .
----------------------------------------------------------------
Usage
----------------------------------------------------------------
.. code-block:: go
type Role struct {
Name string
}
type Person struct {
Name string
Age int
WorkPlace string
Role []*Role
}
L := lua.NewState()
if err := L.DoString(`
person = {
name = "Michel",
age = "31", -- weakly input
work_place = "San Jose",
role = {
{
name = "Administrator"
},
{
name = "Operator"
}
}
}
`); err != nil {
panic(err)
}
var person Person
if err := gluamapper.Map(L.GetGlobal("person").(*lua.LTable), &person); err != nil {
panic(err)
}
fmt.Printf("%s %d", person.Name, person.Age)
----------------------------------------------------------------
License
----------------------------------------------------------------
MIT
----------------------------------------------------------------
Author
----------------------------------------------------------------
Yusuke Inuzuka
Documentation
¶
Overview ¶
gluamapper provides an easy way to map GopherLua tables to Go structs.
Index ¶
Examples ¶
Constants ¶
View Source
const StructTagName = "gluamapper"
Variables ¶
This section is empty.
Functions ¶
func FromGoValue ¶
func FromGoValue(L *lua.LState, v any) lua.LValue
func Map ¶
Map maps the lua table to the given struct pointer with default options.
Example ¶
type Role struct {
Name string
}
type Person struct {
Name string
Age int
WorkPlace string
Role []*Role
}
L := lua.NewState()
if err := L.DoString(`
person = {
name = "Michel",
age = "31", -- weakly input
work_place = "San Jose",
role = {
{
name = "Administrator"
},
{
name = "Operator"
}
}
}
`); err != nil {
panic(err)
}
var person Person
if err := Map(L.GetGlobal("person").(*lua.LTable), &person); err != nil {
panic(err)
}
fmt.Printf("%s %d", person.Name, person.Age)
Output: Michel 31
func MatchSnakeCase ¶
func ToUpperCamelCase ¶
ToUpperCamelCase is an Option.NameFunc that converts strings from snake case to upper camel case.
Types ¶
type Mapper ¶
type Mapper struct {
Option Option
}
Mapper maps a lua table to a Go struct pointer.
type Option ¶
type Option struct {
// Function to convert a lua table key to Go's one. This defaults to "Id".
NameFunc func(string) string
DecoderConfig *mapstructure.DecoderConfig
}
Option is a configuration that is used to create a new mapper.
Source Files
Click to show internal directories.
Click to hide internal directories.