@spec encode(any(), :json) :: {:ok, String.t()} | {:error, Exception.t()}

Encode the data in json format.

This is done in 2 steps:

• first, the data is converted into a jsonable format
• the result is encoded in json via Elixir's built-in JSON

Step 1 is overridable via the Bolty.ResponseEncoder.Json protocol.

Bolty.Types.* structs can also be handed straight to JSON.encode!/1 (bolty ships the JSON.Encoder implementations); this function is the convenience wrapper that runs the jsonable conversion first.

Example

iex> data = %{"t1" => %Bolty.Types.Node{
...>     id: 69,
...>     labels: ["Test"],
...>     properties: %{
...>       "created" => %Bolty.Types.DateTimeWithTZOffset{
...>         naive_datetime: ~N[2016-05-24 13:26:08.543],
...>         timezone_offset: 7200
...>       },
...>       "uuid" => 12345
...>     }
...>   }
...> }
iex> {:ok, json} = Bolty.ResponseEncoder.encode(data, :json)
iex> decoded = JSON.decode!(json)
iex> decoded["t1"]["id"]
69
iex> decoded["t1"]["properties"]["created"]
"2016-05-24T13:26:08.543+02:00"

iex> match?({:error, _}, Bolty.ResponseEncoder.encode(<<0xFF>>, :json))
true

@spec encode!(any(), :json) :: String.t() | no_return()

Encode the data in json format.

Similar to encode/1 except it will unwrap the error tuple and raise in case of errors.

Example

iex> data = %{"t1" => %Bolty.Types.Node{
...>     id: 69,
...>     labels: ["Test"],
...>     properties: %{
...>       "created" => %Bolty.Types.DateTimeWithTZOffset{
...>         naive_datetime: ~N[2016-05-24 13:26:08.543],
...>         timezone_offset: 7200
...>       },
...>       "uuid" => 12345
...>     }
...>   }
...> }
iex> json = Bolty.ResponseEncoder.encode!(data, :json)
iex> JSON.decode!(json)["t1"]["labels"]
["Test"]