mjson.md

The mjson module

Types

val()

Represents a JSON value.

-type val() :: obj() | array() | num() | str() | boolean() | null.

enc_val()

Represents a JSON value for encoding. Just like a val(), but also accepts datetime tuples, atoms as strings and iodata as object member names.

-type enc_val() :: val() | calendar:datetime() | enc_obj() | enc_str().

obj()

Represents a JSON object.

-type obj()     :: #{str() => val()}.

array()

Represents a JSON array.

-type array()   :: [val()].

num()

Represents a JSON number.

-type num()     :: number().

str()

Represents a JSON string.

-type str()     :: binary().

enc_obj()

When encoding, object member names can be atoms and iodata.

-type enc_obj() :: #{enc_str() | iodata() => enc_val()}.

enc_str()

When encoding, atoms and binaries will be encoded as JSON strings.

-type enc_str() :: binary() | atom().

encode_opts()

Options for encode/2.

-type encode_opts() ::
        #{
           %% Set to `true` to encode without any whitespace.
           compact => boolean()

           %% Indent all rows with this whitespace.
         , indent => iodata()

           %% Print object members sorted by their name.
         , sort_objects => boolean()

           %% Timezone used in encoding of datetime values (default `utc`).
           %% If a `TzStr` is used, it should be on the form "HH:MM", to
           %% be RFC3339/ISO8601-compatible.
         , tz => utc | local | OffsetMinutes :: integer() | TzStr :: iodata()
         }.

Functions

decode/1

-spec decode(binary()) -> {ok, val()}.

decode/1

-spec decode(binary(), decode_opts()) -> {ok, val()}.

If Bin does not contain valid JSON, decode/1 crashes.

decode/2

-spec decode(binary()) -> {ok, val()}.

decode/2

-spec decode(binary(), decode_opts()) -> {ok, val()}.

If Bin does not contain valid JSON, decode/1 crashes.

encode/1

-spec encode(enc_val()) -> iodata().

encode/1

-spec encode(enc_val(), encode_opts()) -> iodata().

encode/2

-spec encode(enc_val()) -> iodata().

encode/2

-spec encode(enc_val(), encode_opts()) -> iodata().