lua
/
df-serialize
mirror of https://gitea.it/1414codeforge/df-serialize
1
0
Fork 0
Code Releases Activity
This is a read-only mirror of https://gitea.it/1414codeforge/df-serialize. Please direct any pull-request, issue or discussion to the main repo.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Commits
1 Branch
0 Tags
33 KiB
Lua 100%
 
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4fd9934232'
${ noResults }
Go to file
Lorenzo Cogotti 4fd9934232 [README] Update library name, improve ldoc documentation. 2 years ago
spec [*] Initial commit. 2 years ago
.gitignore [.gitignore] Add ldoc output directory to ignored files 2 years ago
LICENSE [LICENSE] Improve license. 2 years ago
README.md [README] Update library name, improve ldoc documentation. 2 years ago
init.lua [*] Initial commit. 2 years 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.