Module yamerl_yamler_compat

yamerl_yamler_compat implements the yamerl API above yamerl_constr.

Copyright © 2012-2014 Yakaz, 2016-2021 Jean-Sébastien Pédron <jean-sebastien.pedron@dumbbell.fr>

Authors: Jean-Sébastien Pédron (jean-sebastien.pedron@dumbbell.fr).

Description

yamerl_yamler_compat implements the yamerl API above yamerl_constr.

See yamler documentation: https://github.com/goertzenator/yamler.

Data Types

yamler_option()

yamler_option() = {schema, yamler_schema()} | {implicit_atoms, boolean()} | implicit_atoms

yamler_schema()

yamler_schema() = yaml_schema_failsafe | yaml_schema_json | yaml_schema_core | yaml_schema_erlang

Function Index

load/1Equivalent to load(String, []).
load/2Constructs a YAML document from an in-memory string.
load_file/1Equivalent to load_file(Filename, []).
load_file/2Constructs a YAML document from a regular file.

Function Details

load/1

load(String) -> Result | Error

Equivalent to load(String, []).

load/2

load(String, Options) -> Result | Error

Constructs a YAML document from an in-memory string.

The yamerl application must be started to use this wrapper.

load_file/1

load_file(Filename) -> Result | Error

Equivalent to load_file(Filename, []).

load_file/2

load_file(Filename, Options) -> Result | Error

Constructs a YAML document from a regular file.


Generated by EDoc