library-mirrors/bitser
1
0
Fork 0
mirror of https://github.com/gvx/bitser.git synced 2024-11-11 01:44:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Serializes and deserializes Lua values with LuaJIT
54 Commits 2 Branches 1 Tag 115 KiB
Lua 100%
e817e4de28
Go to file
Robin Wellner e817e4de28
Close #12 (serialization bug for string "len") 
Thanks to nikki93 for spotting the issue and suggesting this solution.
2018-11-04 13:07:19 +00:00
cases Add a non-reentrant version of bitser 2016-02-23 12:09:57 +01:00
spec Return true in mock write so asserts work 2018-02-20 15:24:17 +01:00
.travis.yml Fix travis build (#10) 2018-02-20 15:15:46 +01:00
bitser.lua Close #12 (serialization bug for string "len") 2018-11-04 13:07:19 +00:00
conf.lua add first version, including benchmarks 2016-02-14 03:52:58 +01:00
main.lua Add more tests 2016-02-23 14:29:29 +01:00
README.md Add note about JIT to readme 2017-03-29 14:50:09 +02:00
USAGE.md Update USAGE.md 2017-01-10 14:38:59 +01: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).