rsjson-lua 0.2.1

a json module based on serde-json (rust)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

--- SPDX-License-Identifier: MIT
---
--- A Lua interface to the rust `serde-json` crate.

local rsjson_lua = require("rsjson_lua")

local rsjson = {}

--- Low-level serde API
---
---@type table
rsjson.serde = rsjson_lua

--- Represents the JSON `null` value.
--- This can be used in the place of
--- `nil` to represent empty values.
---
---@alias rsjson.null lightuserdata

---@type rsjson.null
rsjson.null = rsjson.serde.null

---@class (exact) rsjson.EncodeConfig: userdata
---
---@field indent number The number of `prefix` to indent lines
---@field prefix string The string to use for indentation
---@field sort_keys boolean Sort JSON keys
---@field empty_table_as_array boolean Convert empty tables to empty arrays
---@field detect_mixed_tables boolean Detect mixed sequence and key tables
---@field error_unsupported boolean Error on unsupported types (functions, userdata, etc)
---@field error_cycles boolean Error on cycles
---
---@field new fun(): rsjson.EncodeConfig
rsjson.EncodeConfig = rsjson.serde.EncodeConfig

---@class (exact) rsjson.DecodeConfig: userdata
---
---@field null boolean Convert `nil` to `rsjson.null`
---@field cast_u64_to_f64 boolean Convert u64 numbers to f64 if they overflow i64
---@field set_array_mt boolean Set the metatable of JSON array tables to `mlua::Lua::array_metatable`
---
---@field new fun(): rsjson.DecodeConfig
rsjson.DecodeConfig = rsjson.serde.DecodeConfig

--- Serialize a Lua object into a JSON string
---
---@param obj any Any Lua object
---@param config? rsjson.EncodeConfig
---
---@return string # The serialized Lua object
function rsjson.encode(obj, config)
    return rsjson.serde.encode(obj, config)
end

--- Deserialize a JSON string into a Lua object
---
---@param str string The JSON string
---@param config? rsjson.DecodeConfig
---
---@return any # The deserialized JSON object
function rsjson.decode(str, config)
    return rsjson.serde.decode(str, config)
end

--- Serialize a Lua object to a file
---
---@param obj any Any Lua object
---@param path string The filepath to write to
---@param indent? number The indent level of lines
---
---@return string # The serialized Lua object
function rsjson.to_file(obj, path, indent)
    local file = io.open(path, "w+")
    if not file then
        error("Could not write file: " .. path)
    end

    local config = nil
    if indent then
        config = rsjson.EncodeConfig:new()
        config.indent = indent
    end

    local content = rsjson.encode(obj, config)
    file:write(content)
    file:flush()
    file:close()
    return content
end

--- Serialize a Lua object to a string
---
---@param obj any Any Lua object
---@param indent? number The indent level of lines
---
---@return string # The serialized Lua object
function rsjson.to_str(obj, indent)
    local config = nil
    if indent then
        config = rsjson.EncodeConfig:new()
        config.indent = indent
    end

    return rsjson.encode(obj, config)
end

--- Deserialize a JSON object from a file
---
---@param path string The filepath to load
---
---@return any # The deserialized JSON object
function rsjson.from_file(path)
    local file = io.open(path, "r")
    if not file then
        error("Could not read file: " .. path)
    end

    local content = file:read("a")
    file:close()

    return rsjson.decode(content)
end

--- Deserialize a JSON object from a string
---
---@param str string The string to load
---
---@return any # The deserialized JSON object
function rsjson.from_str(str)
    return rsjson.decode(str)
end

return rsjson