Module jsone

Description
Data Types
Function Index
Function Details

JSON decoding/encoding module.

Data Types

decode_option()


decode_option() = {object_format, tuple | proplist | map}

object_format:

Decoded JSON object format
tuple: An object is decoded as {[]} if it is empty, otherwise {[{Key, Value}]}.
proplist: An object is decoded as [{}] if it is empty, otherwise [{Key, Value}].
map: An object is decoded as #{} if it is empty, otherwise #{Key => Value}.
default: tuple

encode_option()


encode_option() = native_utf8 | {space, non_neg_integer()} | {indent, non_neg_integer()}

native_utf8:

Encodes UTF-8 characters as a human-readable(non-escaped) string

{space, N}:

Inserts N spaces after every commna and colon
default: 0

{indent, N}:

Inserts a newline and N spaces for each level of indentation
default: 0

json_array()


json_array() = [json_value()]

json_boolean()


json_boolean() = boolean()

json_number()


json_number() = number()

json_object()


json_object() = json_object_format_tuple() | json_object_format_proplist() | json_object_format_map()

json_object_format_map()


json_object_format_map() = #{}

json_object_format_proplist()


json_object_format_proplist() = [{}] | json_object_members()

json_object_format_tuple()


json_object_format_tuple() = {json_object_members()}

json_object_members()


json_object_members() = [{json_string(), json_value()}]

json_string()


json_string() = binary() | atom()

NOTE: decode/1 always returns binary() value

json_value()


json_value() = json_number() | json_string() | json_array() | json_object() | json_boolean() | null

Function Index

decode/1	Equivalent to `decode(Json, [])`.
decode/2	Decodes an erlang term from json text (a utf8 encoded binary).
encode/1	Equivalent to `encode(JsonValue, [])`.
encode/2	Encodes an erlang term into json text (a utf8 encoded binary).
try_decode/1	Equivalent to `try_decode(Json, [])`.
try_decode/2	Decodes an erlang term from json text (a utf8 encoded binary).
try_encode/1	Equivalent to `try_encode(JsonValue, [])`.
try_encode/2	Encodes an erlang term into json text (a utf8 encoded binary).

Function Details

decode/1


decode(Json::binary()) -> json_value()

Equivalent to decode(Json, []).

decode/2


decode(Json::binary(), Options::[decode_option()]) -> json_value()

Decodes an erlang term from json text (a utf8 encoded binary)

Raises an error exception if input is not valid json

  > jsone:decode(<<"1">>, []).
  1
  > jsone:decode(<<"wrong json">>, []).
  ** exception error: bad argument
      in function  jsone_decode:number_integer_part/4
         called as jsone_decode:number_integer_part(<<"wrong json">>,1,[],<<>>)
      in call from jsone:decode/1 (src/jsone.erl, line 71)

encode/1


encode(JsonValue::json_value()) -> binary()

Equivalent to encode(JsonValue, []).

encode/2


encode(JsonValue::json_value(), Options::[encode_option()]) -> binary()

Encodes an erlang term into json text (a utf8 encoded binary)

Raises an error exception if input is not an instance of type json_value()

  > jsone:encode([1, null, 2]).
  <<"[1,null,2]">>
  > jsone:encode([1, hoge, 2]).  % 'hoge' atom is not a json value
  ** exception error: bad argument
       in function  jsone_encode:value/3
          called as jsone_encode:value(hoge,[{array_values,[2]}],<<"[1,">>)
       in call from jsone:encode/1 (src/jsone.erl, line 97)

try_decode/1


try_decode(Json::binary()) -> {ok, json_value(), Remainings::binary()} | {error, {Reason::term(), [erlang:stack_item()]}}

Equivalent to try_decode(Json, []).

try_decode/2


try_decode(Json::binary(), Options::[decode_option()]) -> {ok, json_value(), Remainings::binary()} | {error, {Reason::term(), [erlang:stack_item()]}}