json

package module
Version: v0.0.0-...-552bb3c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2020 License: Unlicense Imports: 3 Imported by: 36

README

gopher-json GoDoc

Package json is a simple JSON encoder/decoder for gopher-lua.

License

Public domain

Documentation

Overview

Package json is a simple JSON encoder/decoder for gopher-lua.

Documentation

The following functions are exposed by the library:

decode(string): Decodes a JSON string. Returns nil and an error string if
                the string could not be decoded.
encode(value):  Encodes a value into a JSON string. Returns nil and an error
                string if the value could not be encoded.

The following types are supported:

Lua      | JSON
---------+-----
nil      | null
number   | number
string   | string
table    | object: when table is non-empty and has only string keys
         | array:  when table is empty, or has only sequential numeric keys
         |         starting from 1

Attempting to encode any other Lua type will result in an error.

Example

Below is an example usage of the library:

import (
    luajson "layeh.com/gopher-json"
)

L := lua.NewState()
luajson.Preload(L)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Decode

func Decode(L *lua.LState, data []byte) (lua.LValue, error)

Decode converts the JSON encoded data to Lua values.

func DecodeValue

func DecodeValue(L *lua.LState, value interface{}) lua.LValue

DecodeValue converts the value to a Lua value.

This function only converts values that the encoding/json package decodes to. All other values will return lua.LNil.

func Encode

func Encode(value lua.LValue) ([]byte, error)

Encode returns the JSON encoding of value.

func Loader

func Loader(L *lua.LState) int

Loader is the module loader function.

func Preload

func Preload(L *lua.LState)

Preload adds json to the given Lua state's package.preload table. After it has been preloaded, it can be loaded using require:

local json = require("json")

Types

This section is empty.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL