Specs

decode(yaml(), decode_opts()) :: {:ok, Yamel.t()} | {:error, parse_error()}

Decodes a YAML string to a map or list.

Returns {:ok, Yamel.t()} or {:error, reason}, where reason is parse_error()

Options

• :keys - indicates the type for the map's keys. Default: :string

Examples

iex> Yamel.decode(
...> ~s"---
...>    - Apple
...>    - Orange
...>    - Strawberry
...>    - Mango")
{:ok, ["Apple", "Orange","Strawberry", "Mango"]}

Specs

decode!(yaml(), decode_opts()) :: Yamel.t()

Decodes a YAML string to a map or list, throws if fails.

Throws parse_error() exception if given YAML cannot be parsed.

Options

• :keys - indicates the type for the map's keys. Default: :string

Examples

iex> Yamel.decode!("
...>     name: Jane Doe
...>     job: Developer
...>     skill: Elite
...>     employed: True")
%{"employed" => true, "job" => "Developer", "name" => "Jane Doe", "skill" => "Elite"}

With option keys: :atom

iex> Yamel.decode!("
...>     name: Jane Doe
...>     job: Developer
...>     skill: Elite
...>     employed: True", keys: :atom)
%{employed: true, job: "Developer", name: "Jane Doe", skill: "Elite"}

Specs

encode(Yamel.t(), Yamel.Encoder.opts()) ::
  {:ok, yaml()} | {:error, reason :: String.t()}

Encodes a YAML term. Returns {:ok, yaml()} where the second term is the encoded YAML term. Otherwise, returns {:error, reason} with reason being a string stating the error reason.

Options

• :quote - The value types to be quoted.

Examples

iex> Yamel.encode(["foo", "bar", "baz"])
{:ok, "- foo\n- bar\n- baz\n\n"}

iex> Yamel.encode([:foo, "bar", 123, true], quote: [:string, :atom, :number])
{:ok, "- \"foo\"\n- \"bar\"\n- \"123\"\n- true\n\n"}

iex> Yamel.encode([:foo, "bar", 12.3, true], quote: [:string, :boolean])
{:ok, "- foo\n- \"bar\"\n- 12.3\n- \"true\"\n\n"}

Specs

encode!(Yamel.t(), Yamel.Encoder.opts()) :: yaml()

Encodes a YAML term directly into a string, throwing an exception if the term can not be encoded.

Options

• :quote - The value types to be quoted.

Examples

iex> Yamel.encode!(["foo", "bar", "baz"])
"- foo\n- bar\n- baz\n\n"

iex> Yamel.encode!([:foo, "bar", 123, true], quote: [:string, :atom, :number])
"- \"foo\"\n- \"bar\"\n- \"123\"\n- true\n\n"

iex> Yamel.encode!([:foo, "bar", 12.3, true], quote: [:string, :boolean])
"- foo\n- \"bar\"\n- 12.3\n- \"true\"\n\n"