The brainless Lua table serialization library. https://doublefourteen.io
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lorenzo Cogotti 26631c607d [init] Respect mode parameter for subtables. 4 weeks ago
spec [*] Initial commit. 2 months ago
.gitignore [.gitignore] Add ldoc output directory to ignored files 2 months ago
LICENSE [LICENSE] Improve license. 2 months ago
README.md [README] Update library name, improve ldoc documentation. 2 months ago
df-serialize-scm-1.rockspec [rockspec] Fix syntax. 2 months ago
init.lua [init] Respect mode parameter for subtables. 4 weeks ago

README.md

df-serialize - A brainless Lua table serializer

df-serialize provides two functions:

  • pack() packs Lua tables to string.
  • unpack() unpacks a string back to a Lua table.

The implementation strives to be useful under the majority of reasonable use cases, to be compact, understandable and sufficiently fast. There is no pretense of complete generality, nor of absolute efficiency. In case df-serialize does not exactly meet your requirements, its code should be immediate enough to tweak to your needs.

Documentation

Code is documented with LDoc.

Documentation may be generated running the command:

ldoc init.lua

ldoc generates a doc directory, open doc/index.html with your favorite browser to read the documentation.

Test suite

The test suite uses busted.

Tests may be run with the command:

lua spec/serialize_spec.lua

License

See LICENSE for details.