Module fast_yaml

Data Types

option()

option() = {plain_as_atom, boolean()} | plain_as_atom | {sane_scalars, boolean()} | sane_scalars | {maps, boolean()} | maps

options()

options() = [option()]

parser_error()

parser_error() = {parser_error, binary(), integer(), integer()}

scanner_error()

scanner_error() = {scanner_error, binary(), integer(), integer()}

yaml_error()

yaml_error() = parser_error() | scanner_error() | memory_error | unexpected_error

Function Index

decode/1
decode/2
decode_from_file/1
decode_from_file/2
encode/1
format_error/1
start/0
stop/0

Function Details

decode/1

decode(Data::iodata()) -> {ok, term()} | {error, yaml_error()}

decode/2

decode(Data::iodata(), Opts::options()) -> {ok, term()} | {error, yaml_error()}

decode_from_file/1

decode_from_file(File::file:filename()) -> {ok, term()} | {error, yaml_error() | file:posix()}

decode_from_file/2

decode_from_file(File::file:filename(), Opts::options()) -> {ok, term()} | {error, yaml_error() | file:posix()}

encode/1

encode(Term::term()) -> iolist()

format_error/1

format_error(Reason::atom() | yaml_error() | file:posix()) -> string()

start/0

start() -> any()

stop/0

stop() -> any()


Generated by EDoc