You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -32,7 +32,7 @@ Returns the embedded rapidjson library version as a Lua string. The lua-rapidjso
32
32
33
33
Parses the given input as a JSON string and returns a Lua table containing the equivalent data. Alias for `json.decode(...)`.
34
34
35
-
<Function>
35
+
<Functionsince="v0.0.3">
36
36
<Parameters>
37
37
<Parametername="jsonString"type="string"/>
38
38
</Parameters>
@@ -45,7 +45,7 @@ Parses the given input as a JSON string and returns a Lua table containing the e
45
45
46
46
Converts the given input table to a JSON string containing the equivalent data. Alias for `json.encode(...)`.
47
47
48
-
<Function>
48
+
<Functionsince="v0.0.3">
49
49
<Parameters>
50
50
<Parametername="luaTable"type="table"/>
51
51
</Parameters>
@@ -58,7 +58,7 @@ Converts the given input table to a JSON string containing the equivalent data.
58
58
59
59
Identical to `json.encode(...)`, but accepts both strings and tables. Returns a human-readable JSON string with indentation and key sorting enabled. Indentation uses four spaces (lua-rapidjson default). You probably don't want to use this for performance-critical code.
60
60
61
-
<Function>
61
+
<Functionsince="v0.0.3">
62
62
<Parameters>
63
63
<Parametername="jsonStringOrTable"/>
64
64
</Parameters>
@@ -71,7 +71,7 @@ Identical to `json.encode(...)`, but accepts both strings and tables. Returns a
71
71
72
72
Identical to `json.pretty`, but uses tabs for indentation (instead of four spaces). This saves some space, but is still unsuitable for performance-critical code paths due to the overhead of sorting and possibly redundantly re-encoding the provided string value.
Copy file name to clipboardExpand all lines: docs/references/api/bindings/miniz.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ Most of the time, you'll want to pass `"no"` or `"finish"` for asynchronous and
54
54
55
55
:::
56
56
57
-
<Function>
57
+
<Functionsince="v0.0.5">
58
58
<Parameters>
59
59
<Parametername="self"type="Deflator"/>
60
60
<Parametername="input"type="string"/>
@@ -73,7 +73,7 @@ Created by [new_inflator](#new_inflator). You can use this to decompress large a
73
73
74
74
Applies [INFLATE](https://en.wikipedia.org/wiki/Deflate#Decoder/decompressor) to the given (DEFLATE-compressed) `input` and returns the decompressed bytes as a Lua string.
75
75
76
-
<Function>
76
+
<Functionsince="v0.0.5">
77
77
<Parameters>
78
78
<Parametername="self"type="Inflator"/>
79
79
<Parametername="input"type="string"/>
@@ -91,7 +91,7 @@ Created by [new_reader](#new_reader) or [new_reader_memory](#new_reader_memory).
91
91
92
92
Extracts the file referenced by the given `fileTableIndex` and returns the file contents (or `""` on failure). The `flags` are passed to `miniz` directly. Since the extraction happens entirely in memory, this method may not be well-suited for extracting very large files.
93
93
94
-
<Function>
94
+
<Functionsince="v0.0.5">
95
95
<Parameters>
96
96
<Parametername="self"type="ZipFileReader"/>
97
97
<Parametername="fileTableIndex"type="number"/>
@@ -105,7 +105,7 @@ Extracts the file referenced by the given `fileTableIndex` and returns the file
105
105
106
106
Returns the file name referenced by the given `fileTableIndex`, or `nil` and an error message if the given index was invalid.
107
107
108
-
<Function>
108
+
<Functionsince="v0.0.5">
109
109
<Parameters>
110
110
<Parametername="self"type="ZipFileReader"/>
111
111
<Parametername="fileTableIndex"type="number"/>
@@ -120,7 +120,7 @@ Returns the file name referenced by the given `fileTableIndex`, or `nil` and an
120
120
121
121
Returns the total number of files within the ZIP archive. This is the maximum `fileTableIndex` that you can pass to other functions.
122
122
123
-
<Function>
123
+
<Functionsince="v0.0.5">
124
124
<Parameters>
125
125
<Parametername="self"type="ZipFileReader"/>
126
126
</Parameters>
@@ -139,7 +139,7 @@ This offset is likely zero for normal archives, but the file format allows stori
139
139
140
140
:::
141
141
142
-
<Function>
142
+
<Functionsince="v0.0.5">
143
143
<Parameters>
144
144
<Parametername="self"type="ZipFileReader"/>
145
145
</Parameters>
@@ -152,7 +152,7 @@ This offset is likely zero for normal archives, but the file format allows stori
152
152
153
153
Returns `true` if the entry referenced by the given `fileTableIndex` is a directory entry, and `false` otherwise.
154
154
155
-
<Function>
155
+
<Functionsince="v0.0.5">
156
156
<Parameters>
157
157
<Parametername="self"type="ZipFileReader"/>
158
158
<Parametername="fileTableIndex"type="number"/>
@@ -166,7 +166,7 @@ Returns `true` if the entry referenced by the given `fileTableIndex` is a direct
166
166
167
167
Searches the internal file system table of the given ZIP archive for an entry that matches `fileSystemPath` and returns the corresponding `fileTableIndex`, or `nil` and an error message if no match was found. It uses a simple linear search method that might have to iterate over the entire table, which is slow for very large files. The `flags` passed to `miniz` can control the way that the search is performed.
168
168
169
-
<Function>
169
+
<Functionsince="v0.0.5">
170
170
<Parameters>
171
171
<Parametername="fileSystemPath"type="string"/>
172
172
<Parametername="flags"type="number"optional/>
@@ -180,7 +180,7 @@ Searches the internal file system table of the given ZIP archive for an entry th
180
180
181
181
Returns a list of attributes for the entry referenced by the given `fileTableIndex`, or `nil` and an error message if the index was invalid.
182
182
183
-
<Function>
183
+
<Functionsince="v0.0.5">
184
184
<Parameters>
185
185
<Parametername="self"type="ZipFileReader"/>
186
186
<Parametername="fileTableIndex"type="number"/>
@@ -215,7 +215,7 @@ Created by [new_writer](#new_writer). You can use this to add files to a ZIP arc
215
215
216
216
Adds (in-memory) a new file entry referenced by `fileSystemPath` with the given `fileContents` to the archive. The `flags` passed to `miniz` control the compression level and settings for this specific entry; it's a bitfield with the level being stored in the lowest byte.
217
217
218
-
<Function>
218
+
<Functionsince="v0.0.5">
219
219
<Parameters>
220
220
<Parametername="self"type="ZipFileWriter"/>
221
221
<Parametername="fileSystemPath"type="string"/>
@@ -227,7 +227,7 @@ Adds (in-memory) a new file entry referenced by `fileSystemPath` with the given
227
227
228
228
Adds (in-memory) the contents of the entry referenced by the given `fileTableIndex` from another ZIP archive to the archive.
229
229
230
-
<Function>
230
+
<Functionsince="v0.0.5">
231
231
<Parameters>
232
232
<Parametername="self"type="ZipFileWriter"/>
233
233
<Parametername="reader"type="ZipFileReader"/>
@@ -245,7 +245,7 @@ Once the archive has been finalized, you can no longer add new entries to it. Yo
245
245
246
246
:::
247
247
248
-
<Function>
248
+
<Functionsince="v0.0.5">
249
249
<Parameters>
250
250
<Parametername="self"type="ZipFileWriter"/>
251
251
</Parameters>
@@ -260,7 +260,7 @@ Once the archive has been finalized, you can no longer add new entries to it. Yo
260
260
261
261
Returns the [Adler-32](https://en.wikipedia.org/wiki/Adler-32) checksum for the given `input`. Supplying an `initialValue` allows processing multiple chunks as they arrive.
@@ -274,7 +274,7 @@ Returns the [Adler-32](https://en.wikipedia.org/wiki/Adler-32) checksum for the
274
274
275
275
Returns the [CRC-32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) checksum for the given `input`. Supplying an `initialValue` allows processing multiple chunks as they arrive.
| v0.0.9 | Removed `stbi_max_bitmap_size` in favor of `stbi_get_required_bmp_size`, `stbi_get_required_png_size`, `stbi_get_required_jpg_size`, and `stbi_get_required_tga_size`|
Copy file name to clipboardExpand all lines: docs/references/api/extensions.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ debug.dump({ 1, 2, 3 })
24
24
25
25
Prints a human-readable string representation of the given object. Mostly useful for dumping tables, but unsuitable for serialization purposes. The output format cannot be considered stable. Currently uses [inspect](/docs/references/api/bindings/inspect) internally, though this may change in the future.
26
26
27
-
<Function>
27
+
<Functionsince="v0.0.1">
28
28
<Parameters>
29
29
<Parametername="object"/>
30
30
</Parameters>
@@ -39,7 +39,7 @@ Prints a human-readable string representation of the given object. Mostly useful
39
39
40
40
Returns a string representing the difference between `firstValue` and `secondValue`. The exact format is subject to change.
41
41
42
-
<Function>
42
+
<Functionsince="v0.0.1">
43
43
<Parameters>
44
44
<Parametername="firstValue"type="string"/>
45
45
<Parametername="firstValue"type="string"/>
@@ -53,7 +53,7 @@ Returns a string representing the difference between `firstValue` and `secondVal
53
53
54
54
Tokenizes the given `inputString` based on a configurable `delimiter` character, which is stripped from the output.
Copy file name to clipboardExpand all lines: docs/references/api/globals.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ Alias for [debug.dump(...)](/docs/references/api/extensions#debugdump).
67
67
68
68
Sets up the metatable of `child` so that it acts as an instance of `parent` (in terms of [object-oriented programming](https://en.wikipedia.org/wiki/Object-oriented_programming)).
0 commit comments