mirror of https://github.com/gvx/bitser.git synced 2024-11-11 01:44:21 +00:00

Serializes and deserializes Lua values with LuaJIT

Go to file

Robin Wellner ba62015f30 more tests!		2016-02-16 01:32:08 +01:00
cases	add first version, including benchmarks	2016-02-14 03:52:58 +01:00
spec	more tests!	2016-02-16 01:32:08 +01:00
.travis.yml	more tests!	2016-02-16 01:32:08 +01:00
bitser.lua	Fix sloppy errors (forgot to pass an argument, haserror -> has_error)	2016-02-15 15:24:07 +01:00
conf.lua	add first version, including benchmarks	2016-02-14 03:52:58 +01:00
main.lua	add first version, including benchmarks	2016-02-14 03:52:58 +01:00
README.md	Add coverage status badge to README	2016-02-15 15:20:55 +01:00

README.md

bitser

Serializes and deserializes Lua values with LuaJIT.

local bitser = require 'bitser'

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

serializedData = bitser.dumps(someData)
someData = bitser.loads(serializedData)

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

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 and serpent.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 and Slither (and probably some other class libraries by accident).

What license is this under?

None yet. It will be open source (probably MIT license) in the near future, but it needs more testing before it's production ready.