ex_ndjson v0.2.0 ExNdjson

Implements encoding and decoding of NDJSON as defined in NDJSON Spec.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Returns the NDJSON encoding of v, raises an exception on error

Parses the NDJSON-encoded data and returns a list of decoded JSON values

Parses the NDJSON-encoded lines in the given path and returns a list of decoded JSON values. Raises an exception if failed to open the file.

Examples

Link to this section Types

Link to this type t()
t() :: nil | true | false | list() | float() | integer() | String.t() | map()

Link to this section Functions

Link to this function child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function marshal!(v)
marshal!([t()]) :: String.t() | no_return()

Returns the NDJSON encoding of v, raises an exception on error.

Examples

iex> ExNdjson.marshal!([%{id: 1}, [1, 2, 3]])
"{"id": "1"}\n[1, 2, 3]\n"
Link to this function start_link(args)
Link to this function unmarshal(v)
unmarshal(iodata()) :: [t()]

Parses the NDJSON-encoded data and returns a list of decoded JSON values.

Examples

iex> ExNdjson.unmarshal('{"id": "1"}\n[1, 2, 3]\r\n')
[%{"id" => "1"}, [1, 2, 3]]
Link to this function unmarshal_from_file!(path)
unmarshal_from_file!(Path.t()) :: [t()] | no_return()

Parses the NDJSON-encoded lines in the given path and returns a list of decoded JSON values. Raises an exception if failed to open the file.

Examples

iex> ExNdjson.unmarshal_from_file!("./fixtures/file.txt")
[%{"id" => "1"}, [1, 2, 3]]