TomlElixir (Toml Elixir v3.1.0)

TomlElixir

TOML parser for elixir.

The package can be installed by adding toml_elixir to your list of dependencies in mix.exs:

def deps do
  [{:toml_elixir, "~> 3.0.0"}]
end

TomlElixir is used by calling decode functions

options()

Decode toml string to map.

Same as decode/2, but raises error on failure.

Encode map to toml string.

Same as encode/2, but raises error on failure.

@type options() :: map() | keyword()

@spec decode(binary(), options()) :: {:ok, map()} | {:error, Exception.t()}

Decode toml string to map.

:spec - The TOML specification version to follow. Can be :"1.1.0" (default) or :"1.0.0".

TomlElixir.decode("toml = true", spec: :"1.1.0")

@spec decode!(binary(), options()) :: map()

Same as decode/2, but raises error on failure.

TomlElixir.decode!("toml = true")

@spec encode(map(), options()) :: {:ok, binary()} | {:error, any()}

Encode map to toml string.

TomlElixir.encode(%{a: 1})

@spec encode!(map(), options()) :: binary()

Same as encode/2, but raises error on failure.

TomlElixir.encode!(%{a: 1})