Yml v0.9.1 Yml View Source

Module for reading/writing yml/yaml files

Link to this section Summary

Read YML file to map

Write map to YML file

Transform map to string before saving

read_from_file(path_to_file)

read_from_file(String.t()) :: {:ok, %{}}

Read YML file to map

iex> Yml.read_from_file("/path_to_file")
{:ok, %{}}

iex> Yml.read_from_file("/path_to_unexisted_file")
{:error, "File reading error"}

write_to_file(path_to_file, content)

write_to_file(String.t(), %{}) :: {:ok, String.t()}

Write map to YML file

iex> Yml.write_to_file("/path_to_file", %{something => %{Hello: "Hello"}})
{:ok, "File is saved"}

write_to_string(content)

write_to_string(%{}) :: {:ok, String.t()}

Transform map to string before saving

iex> Yml.write_to_string(%{something => %{Hello: "Hello"}})
{:ok, ""}