library-mirrors/bitser
1
0
Fork 0
mirror of https://github.com/gvx/bitser.git synced 2024-10-15 15:44:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Serializes and deserializes Lua values with LuaJIT
43 Commits 2 Branches 1 Tag 115 KiB
Lua 100%
3b8dae1dde
Go to file
Robin Wellner 3b8dae1dde Add tests for resources whose name is also used as a string
2016-10-31 12:20:29 +01:00
cases Add a non-reentrant version of bitser 2016-02-23 12:09:57 +01:00
spec Add tests for resources whose name is also used as a string 2016-10-31 12:20:29 +01:00
.travis.yml Make love global writable 2016-02-23 14:32:36 +01:00
bitser.lua Fix reference serialization inside classes 2016-05-11 00:57:41 -04: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 Readme syntax highlighting 2016-04-03 19:14:14 +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)
serializedData = love.filesystem.newFileData("filename")
someValue = bitser.loadData(serializedData:getPointer(), serializedData:getSize())

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