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 b2365c4c0c Update USAGE.md		2017-01-10 14:38:59 +01:00
cases	Add a non-reentrant version of bitser	2016-02-23 12:09:57 +01:00
spec	Adds support for Moonscript classes (#6 )	2017-01-08 02:18:11 +01:00
.travis.yml	Make love global writable	2016-02-23 14:32:36 +01:00
bitser.lua	Adds support for Moonscript classes (#6 )	2017-01-08 02:18:11 +01: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	Simplify example in README	2017-01-08 16:33:42 +01:00
USAGE.md	Update USAGE.md	2017-01-10 14:38:59 +01:00

README.md

bitser

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).

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).