messagepack v0.2.2 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

decode(binary, options \\ [])

Specs

decode(binary, Keyword.t) ::
  {:ok, term} |
  {:error, {:badarg, binary}}

Decode Messagepack to a term.

decode!(binary, options \\ [])

Specs

decode!(binary, Keyword.t) :: term | no_return

Decode Messagepack to a term, raises an exception on error.

encode(term, options \\ [])

Specs

encode(term, Keyword.t) ::
  {:ok, binary} |
  {:error, {:badarg, term}}

Encode a term to Messagepack as binary.

encode!(term, options \\ [])

Specs

encode!(term, Keyword.t) :: binary | no_return

Encode a term to Messagepack as binary, raises an exception on error.