Module yamerl

Description
Function Index
Function Details

Wrappers for common uses of 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

Wrappers for common uses of yamerl_constr.

Function Index

decode/1	Equivalent to `yamerl_constr:string(String)`.
decode/2	Equivalent to `yamerl_constr:string(String, Options)`.
decode_file/1	Equivalent to `yamerl_constr:file(Filename)`.
decode_file/2	Equivalent to `yamerl_constr:file(Filename, Options)`.

Function Details

decode/1

decode(String) -> Result | no_return()

String = unicode_data()
Result = [yamerl_doc()] | [yamerl_simple_doc()] | term()

Equivalent to yamerl_constr:string(String).

decode/2

decode(String, Options) -> Result | no_return()

String = unicode_data()
Options = [yamerl_parser:yamerl_parser_option() | yamerl_constr_option() | proplists:property()]
Result = [yamerl_doc()] | [yamerl_simple_doc()] | term()

Equivalent to yamerl_constr:string(String, Options).

decode_file/1

decode_file(Filename) -> Result | no_return()

Filename = string()
Result = [yamerl_doc()] | [yamerl_simple_doc()] | term()

Equivalent to yamerl_constr:file(Filename).

decode_file/2

decode_file(Filename, Options) -> Result | no_return()

Filename = string()
Options = [yamerl_parser:yamerl_parser_option() | yamerl_constr_option() | proplists:property()]
Result = [yamerl_doc()] | [yamerl_simple_doc()] | term()

Equivalent to yamerl_constr:file(Filename, Options).

Generated by EDoc