valitydev/yamerl
14
0
Fork 0
mirror of https://github.com/valitydev/yamerl.git synced 2024-11-06 02:45:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Use yamerl_constr:new({file, ...}), like yamerl_constr:file/{1, 2}

Browse Source
This commit is contained in:
Jean-Sébastien Pédron 2012-12-12 11:46:05 +01:00
parent 7d38065b3c
commit 511f7928e6
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/reference-manual/module-yamerl_constr.md
View File

@ -86,7 +86,7 @@ If parsing or construction fails, throw an exception.
##### Parse a valid stream
```erlang
Stream_St1 = yamerl_constr:new("<stdin>"),
Stream_St1 = yamerl_constr:new({file, "<stdin>"}),
{continue, Stream_St2} = yamerl_constr:next_chunk(Stream_St1, <<"He">>),
{continue, Stream_St3} = yamerl_constr:next_chunk(Stream_St2, <<"ll">>),
yamerl_constr:last_chunk(Stream_St3, <<"o!">>).
@ -104,7 +104,7 @@ Returns:
##### Parse an invalid stream
```erlang
Stream_St1 = yamerl_constr:new("<stdin>"),
Stream_St1 = yamerl_constr:new({file, "<stdin>"}),
{continue, Stream_St2} = yamerl_constr:next_chunk(Stream_St1, <<"'He">>),
{continue, Stream_St3} = yamerl_constr:next_chunk(Stream_St2, <<"ll">>),
yamerl_constr:last_chunk(Stream_St3, <<"o!">>) % Unfinished single-quoted scalar.

5
doc/user-guide/recipe-basic-parsing.md
View File

@ -18,8 +18,9 @@ Documents = yamerl_constr:file("input.yaml").
* To parse a stream:
```erlang
% Create a new construction state. The only required argument is an
% arbitrary term describing the source of the data.
Constr_State = yamerl_constr:new("<stdin>"),
% arbitrary term describing the source of the data. Here, we use the
% same term structure as yamerl_constr:file/{1, 2}.
Constr_State = yamerl_constr:new({file, "<stdin>"}),
% Feed the parser with binary chunks. The developer is responsible for
% reading the chunk from the underlying source.