library-mirrors/bitser
1
0
Fork 0
mirror of https://github.com/gvx/bitser.git synced 2024-11-24 06:54:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Serializes and deserializes Lua values with LuaJIT
73 Commits 2 Branches 1 Tag 115 KiB
Lua 100%
16d13ece9d
Go to file
R.E.J. Wellner 16d13ece9d Fix #30 by adding ISC license file
2022-07-01 15:55:16 +02:00
cases Add ability to serialize metatables 2020-12-26 14:22:57 +01:00
spec Add initial version of the extension API 2021-03-30 17:14:14 +02:00
.travis.yml Update slither url 2020-12-26 14:32:19 +01:00
bitser.lua Missed a mention of disable_extensions! 2021-03-30 17:22:37 +02:00
conf.lua Close #13 2020-04-27 19:47:09 +02:00
EXTENSION_API.md Add initial version of the extension API 2021-03-30 17:14:14 +02:00
LICENSE.txt Fix #30 by adding ISC license file 2022-07-01 15:55:16 +02:00
main.lua Add ability to serialize metatables 2020-12-26 14:22:57 +01:00
README.md Add note about JIT to readme 2017-03-29 14:50:09 +02:00
USAGE.md Add initial version of the extension API 2021-03-30 17:14:14 +02:00

README.md

bitser

Build Status Coverage Status

Serializes and deserializes Lua values with LuaJIT.

local bitser = require 'bitser'

bitser.register('someResource', someResource)
bitser.registerClass(SomeClass)

serializedString = bitser.dumps(someValue)
someValue = bitser.loads(serializedString)

Documentation can be found in USAGE.md.

Pull requests, bug reports and other feedback welcome! ❤️

Bitser is released under the ISC license (functionally equivalent to the BSD 2-Clause and MIT licenses).

Please note that bitser requires LuaJIT for its ffi library and JIT compilation. Without JIT, it may or may not run, but it will be much slower than usual. This primarily affects Android and iOS, because JIT is disabled on those platforms.

Why would I use this?

Because it's fast. Because it produces tiny output. Because the name means "snappier" or "unfriendlier" in Dutch. Because it's safe to use with untrusted data.

Because it's inspired by binser, which is great.

How do I use the benchmark thingy?

Download zero or more of binser.lua, ser.lua, smallfolk.lua, serpent.lua and MessagePack.lua, and run:

love .

You do need LÖVE for that.

You can add more cases in the folder cases/ (check out _new.lua), and add other serializers to the benchmark in main.lua. If you do either of those things, please send me a pull request!

You can register classes?

Yes. At the moment, bitser supports MiddleClass, SECL, hump.class, Slither and Moonscript classes (and probably some other class libraries by accident).