Module sr_json

Description
Data Types
Function Index
Function Details

Json abstraction library.

Description

Json abstraction library

Data Types

json()

json() = object() | [object()] | binary() | number() | boolean() | null

key()

key() = binary() | atom()

object()

object() = #{key() => json()}

Function Index

decode/1	String to internal representation.
decode_date/1	Parse binaries as datetimes using iso8601.
decode_null/1	Decode 'null' as 'undefined'.
encode/1	Internal representation to string.
encode_date/1	Format datetimes as binaries using iso8601.
encode_null/1	Encode 'undefined' as 'null'.
error/1	Format errors as jsons.

Function Details

decode/1

decode(Data::iodata()) -> json()

String to internal representation

decode_date/1

decode_date(DateTime::binary()) -> calendar:datetime()

Parse binaries as datetimes using iso8601

To do

remove binary_to_list when is8601 specs are fixed

decode_null/1

decode_null(Json::null) -> undefined

Decode 'null' as 'undefined'. Leave everything else as is.

encode/1

encode(Json::json()) -> iodata()

Internal representation to string

encode_date/1

encode_date(DateTime::calendar:datetime()) -> binary()

Format datetimes as binaries using iso8601

encode_null/1

encode_null(Json::undefined) -> null

Encode 'undefined' as 'null'. Leave everything else as is.

error/1

error(Error::binary()) -> iodata()

Format errors as jsons. Given the error Reason, this function returns the json equivalent to {"error": "Reason"}.

Generated by EDoc, Sep 12 2016, 12:29:07.