##################
MessagePack Erlang
##################
.. image:: https://secure.travis-ci.org/msgpack/msgpack-erlang.png
.. image:: https://drone.io/github.com/msgpack/msgpack-erlang/status.png
prequisites for runtime
-----------------------
`Erlang runtime system `_ , >= R15B -- otherwise rebar won't work.
Based on `the new msgpack spec 232a0d `_ .
Now this supports string type.
::
1> {ok, "埼玉"} = msgpack:unpack(msgpack:pack("埼玉")).
{ok,[22524,29577]}
There are several options for `msgpack:pack/2` and `msgpack:unpack/2` .
See `msgpack:options()` in `msgpack.hrl`.
rebar.config
------------
::
{deps, [
{msgpack, ".*",
{git, "git://github.com/msgpack/msgpack-erlang.git", "master"}}
]}.
Simple deserialization
::
Ham = msgpack:pack(Spam),
{ok, Spam} = msgpack:unpack(Ham).
Stream deserialization
::
{Term0, Rest0} = msgpack:unpack_stream(Binary),
{Term1, Rest1} = msgpack:unpack_stream(Rest0),
...
Ext type
--------
Now msgpack-erlang supports ext type. Now you can serialize everything
with your original (de)serializer. That will enable us to handle
erlang- native types like `pid()`, `ref()` contained in `tuple()`. See
`test/msgpack_ext_example_tests.erl` for example code.
::
Packer = fun({ref, Ref}, Opt) when is_ref(Ref) -> {ok, {12, term_to_binary(Ref)}} end,
Unpacker = fun(12, Bin) -> {ok, {ref, binary_to_term(Ref)}},
Ref = make_ref(),
Opt = [{ext,{Packer,Unpacker}}],
{ok, {foobar, Ref}} = msgpack:unpack(msgpack:pack({foobar, Ref}, Opt), Opt).
This is still experimental feature, so I'm waiting for your feedback.
Compatibility mode
------------------
To use as same with `old spec `_ ::
OldHam = msgpack:pack(Spam, [{enable_str,false}]),
{ok, Spam} = msgpack:unpack(OldHam, [{enable_str,false}]).
Since 0.2.3 now it's **false by default**.
experimental feature: NIF (de)serializer
----------------------------------------
**Currently NIF is unavailable on both new and old spec.**
since 0.1.1 - only tested in MacOS, Linux
::
test/bench_tests.erl:36:<0.125.0>: serialize: 0.543 s
test/bench_tests.erl:37:<0.125.0>: deserialize: 0.653 s
test/bench_tests.erl:38:<0.125.0>: for 2041 KB test data(jiffy).
test/bench_tests.erl:42:<0.125.0>: serialize: 0.508 s
test/bench_tests.erl:43:<0.125.0>: deserialize: 0.630 s
test/bench_tests.erl:44:<0.125.0>: for 2041 KB test data(jsx).
test/bench_tests.erl:54:<0.125.0>: serialize: 0.063 s
test/bench_tests.erl:55:<0.125.0>: deserialize: 0.053 s
test/bench_tests.erl:56:<0.125.0>: for 3828 KB test data(t2b/b2t).
test/bench_tests.erl:75:<0.125.0>: serialize: 1.332 s
test/bench_tests.erl:87:<0.125.0>: deserialize: 1.601 s
test/bench_tests.erl:88:<0.125.0>: for 2041 KB test data(jiffy x 5).
test/bench_tests.erl:75:<0.125.0>: serialize: 1.243 s
test/bench_tests.erl:87:<0.125.0>: deserialize: 3.233 s
test/bench_tests.erl:88:<0.125.0>: for 2041 KB test data(jsx x 5).
test/bench_tests.erl:75:<0.125.0>: serialize: 0.076 s
test/bench_tests.erl:87:<0.125.0>: deserialize: 0.061 s
test/bench_tests.erl:88:<0.125.0>: for 3828 KB test data(t2b/b2t x 5).
License
-------
Apache License 2.0