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
18 Commits 2 Branches 1 Tag 115 KiB
Lua 100%
95611fecfb
Go to file
Robin Wellner 95611fecfb update README
2016-02-16 02:26:13 +01:00
cases add first version, including benchmarks 2016-02-14 03:52:58 +01:00
spec fix typo in test 2016-02-16 02:17:48 +01:00
.travis.yml don't do coverage for downloaded class libraries (hopefully) 2016-02-16 01:51:35 +01:00
bitser.lua add ability to load from raw data 2016-02-16 02:08: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 update README 2016-02-16 02:26:13 +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())

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