2016-02-14 00:44:30 +00:00
|
|
|
# bitser
|
|
|
|
|
|
2016-02-15 13:34:52 +00:00
|
|
|
[](https://travis-ci.org/gvx/bitser)
|
2016-02-15 14:20:55 +00:00
|
|
|
[](https://coveralls.io/github/gvx/bitser?branch=master)
|
2016-02-15 13:34:52 +00:00
|
|
|
|
2016-02-14 03:30:05 +00:00
|
|
|
Serializes and deserializes Lua values with LuaJIT.
|
|
|
|
|
|
2016-04-03 18:14:14 +00:00
|
|
|
```lua
|
|
|
|
|
local bitser = require 'bitser'
|
2016-02-14 03:30:05 +00:00
|
|
|
|
2016-04-03 18:14:14 +00:00
|
|
|
bitser.register('someResource', someResource)
|
|
|
|
|
bitser.registerClass(SomeClass)
|
2016-02-14 03:30:05 +00:00
|
|
|
|
2016-04-03 18:14:14 +00:00
|
|
|
serializedString = bitser.dumps(someValue)
|
|
|
|
|
someValue = bitser.loads(serializedString)
|
|
|
|
|
```
|
2016-02-14 03:30:05 +00:00
|
|
|
|
2017-01-08 15:31:24 +00:00
|
|
|
Documentation can be found in [USAGE.md](USAGE.md).
|
|
|
|
|
|
2016-02-14 03:30:05 +00:00
|
|
|
Pull requests, bug reports and other feedback welcome! :heart:
|
|
|
|
|
|
2016-02-16 01:35:43 +00:00
|
|
|
Bitser is released under the ISC license (functionally equivalent to the BSD
|
|
|
|
|
2-Clause and MIT licenses).
|
|
|
|
|
|
2016-02-14 03:30:05 +00:00
|
|
|
## Why would I use this?
|
|
|
|
|
|
|
|
|
|
Because it's fast. Because it produces tiny output. Because the name means "snappier"
|
2016-02-16 01:45:24 +00:00
|
|
|
or "unfriendlier" in Dutch. Because it's safe to use with untrusted data.
|
2016-02-14 03:30:05 +00:00
|
|
|
|
|
|
|
|
Because it's inspired by [binser](https://github.com/bakpakin/binser), which is great.
|
|
|
|
|
|
|
|
|
|
## How do I use the benchmark thingy?
|
|
|
|
|
|
2016-02-23 11:16:03 +00:00
|
|
|
Download zero or more of [binser.lua](https://raw.githubusercontent.com/bakpakin/binser/master/binser.lua),
|
|
|
|
|
[ser.lua](https://raw.githubusercontent.com/gvx/Ser/master/ser.lua),
|
|
|
|
|
[smallfolk.lua](https://raw.githubusercontent.com/gvx/Smallfolk/master/smallfolk.lua),
|
|
|
|
|
[serpent.lua](https://raw.githubusercontent.com/pkulchenko/serpent/master/src/serpent.lua) and
|
|
|
|
|
[MessagePack.lua](https://raw.githubusercontent.com/fperrad/lua-MessagePack/master/src/MessagePack.lua), and run:
|
2016-02-14 03:30:05 +00:00
|
|
|
|
|
|
|
|
love .
|
|
|
|
|
|
|
|
|
|
You do need [LÖVE](https://love2d.org/) 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?
|
|
|
|
|
|
2017-01-08 01:18:11 +00:00
|
|
|
Yes. At the moment, bitser supports MiddleClass, SECL, hump.class, Slither and Moonscript classes (and
|
2016-02-14 03:30:05 +00:00
|
|
|
probably some other class libraries by accident).
|
