messagepack v0.4.0 Messagepack
MessagePack for Elixir / Erlang
Example
elixir:
iex(1)> defmodule Example do
...(1)> defstruct [:compact, :schema]
...(1)> end
{:module, Example, <<...>>, %Example{compact: nil, schema: nil}}
iex(2)> x = %Example{:compact => true, :schema => 0}
%Example{compact: true, schema: 0}
iex(3)> x = Messagepack.decode!(Messagepack.encode!(x))
%Example{compact: true, schema: 0}
Summary
Functions
Decode Messagepack to a term
Decode Messagepack to a term, raises an exception on error
Encode a term to Messagepack as binary
Encode a term to Messagepack as binary, raises an exception on error
Functions
Specs
decode(binary, Keyword.t) ::
{:ok, term} |
{:error, {:badarg, binary}}
Decode Messagepack to a term.
Specs
decode!(binary, Keyword.t) :: term | no_return
Decode Messagepack to a term, raises an exception on error.
Specs
encode(term, Keyword.t) ::
{:ok, binary} |
{:error, {:badarg, term}}
Encode a term to Messagepack as binary.
Specs
encode!(term, Keyword.t) :: binary | no_return
Encode a term to Messagepack as binary, raises an exception on error.