gvsafronov/rapidjson
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add API doc for Writer::Reset() and Writer::IsComplete()

Browse Source
This commit is contained in:
Milo Yip 2014-07-13 13:27:15 +08:00
parent 5babae98e5
commit 27101d9cd1
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/rapidjson/writer.h
View File

@ -44,6 +44,24 @@ public:
os_(&os), level_stack_(allocator, levelDepth * sizeof(Level)), os_(&os), level_stack_(allocator, levelDepth * sizeof(Level)),
doublePrecision_(kDefaultDoublePrecision), hasRoot_(false) {} doublePrecision_(kDefaultDoublePrecision), hasRoot_(false) {}
//! Reset the writer with a new stream.
/*!
This function reset the writer with a new stream and default settings,
in order to make a Writer object reusable for output multiple JSONs.
\param os New output stream.
\code
Writer<OutputStream> writer(os1);
writer.StartObject();
// ...
writer.EndObject();
writer.Reset(os2);
writer.StartObject();
// ...
writer.EndObject();
\endcode
*/
void Reset(OutputStream& os) { void Reset(OutputStream& os) {
os_ = &os; os_ = &os;
doublePrecision_ = kDefaultDoublePrecision; doublePrecision_ = kDefaultDoublePrecision;
@ -51,6 +69,10 @@ public:
level_stack_.Clear(); level_stack_.Clear();
} }
//! Checks whether the output is a complete JSON.
/*!
A complete JSON has a complete root object or array.
*/
bool IsComplete() const { bool IsComplete() const {
return hasRoot_ && level_stack_.Empty(); return hasRoot_ && level_stack_.Empty();
} }