jasder
/
simdjson
1
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

[no ci]

This commit is contained in:
Daniel Lemire 2021-08-10 15:02:51 -04:00 committed by GitHub
parent b7dee3e9c8
commit e30123d58f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/basics.md
View File

@ -179,11 +179,10 @@ documents.
### Parser, Document and JSON Scope ### Parser, Document and JSON Scope
Because a document is an iterator over the JSON text, both the JSON text and the parser must For code safety, you should keep (1) the `parser` instance, (2) the input string and (3) the document instance alive throughout your parsing. Additionally, you should follow the following rules:
remain alive (in scope) while you are using it. Further, a `parser` may have at most
one document open at a time, since it holds allocated memory used for the parsing. - A `parser` may have at most one document open at a time, since it holds allocated memory used for the parsing.
In particular, if you must pass a document instance to a function, you should avoid - By design, you should only have one `document` instance per JSON document. Thus, if you must pass a document instance to a function, you should avoid passing it by value: choose to pass it by reference instance to avoid the copy. (We also provide a `document_reference` class if you need to pass by value.)
passing it by value: choose to pass it by reference instance to avoid the copy.
During the `iterate` call, the original JSON text is never modified--only read. After you are done During the `iterate` call, the original JSON text is never modified--only read. After you are done
with the document, the source (whether file or string) can be safely discarded. with the document, the source (whether file or string) can be safely discarded.