Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / external / github.com / Tencent / rapidjson / 57869fcccbf419f45c5d376f4bb0cb3340786d1e / . / document_8h.html
blob: 8b30f4630654c08c3f7f7c837ffc83539e7ef52a [file] [log] [blame]
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.7-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]7<meta name="generator" content="Doxygen 1.8.13"/>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]8<title>RapidJSON: include/rapidjson/document.h File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]14<script type="text/javascript" src="navtreedata.js"></script>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]20<script type="text/javascript" src="search/searchdata.js"></script>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]23 $(document).ready(function() { init_search(); });
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]24</script>
25<link href="doxygen.css" rel="stylesheet" type="text/css" />
26<link href="doxygenextra.css" rel="stylesheet" type="text/css"/>
27</head>
28<body>
29<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
miloyip0ab4ce12017-09-13 09:20:27 +0000[diff] [blame]30<div id="topbanner"><a href="https://github.com/Tencent/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]31 <div id="MSearchBox" class="MSearchBoxInactive">
32 <span class="left">
33 <img id="MSearchSelect" src="search/mag_sel.png"
34 onmouseover="return searchBox.OnSearchSelectShow()"
35 onmouseout="return searchBox.OnSearchSelectHide()"
36 alt=""/>
37 <input type="text" id="MSearchField" value="Search" accesskey="S"
38 onfocus="searchBox.OnSearchFieldFocus(true)"
39 onblur="searchBox.OnSearchFieldFocus(false)"
40 onkeyup="searchBox.OnSearchFieldChange(event)"/>
41 </span><span class="right">
42 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
43 </span>
44 </div>
45<!-- end header part -->
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]46<!-- Generated by Doxygen 1.8.13 -->
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]47<script type="text/javascript">
48var searchBox = new SearchBox("searchBox", "search",false,'Search');
49</script>
50</div><!-- top -->
51<div id="side-nav" class="ui-resizable side-nav-resizable">
52 <div id="nav-tree">
53 <div id="nav-tree-contents">
54 <div id="nav-sync" class="sync"></div>
55 </div>
56 </div>
57 <div id="splitbar" style="-moz-user-select:none;"
58 class="ui-resizable-handle">
59 </div>
60</div>
61<script type="text/javascript">
62$(document).ready(function(){initNavTree('document_8h.html','');});
63</script>
64<div id="doc-content">
65<!-- window showing the filter options -->
66<div id="MSearchSelectWindow"
67 onmouseover="return searchBox.OnSearchSelectShow()"
68 onmouseout="return searchBox.OnSearchSelectHide()"
69 onkeydown="return searchBox.OnSearchSelectKey(event)">
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]70</div>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]71
72<!-- iframe showing the search results (closed by default) -->
73<div id="MSearchResultsWindow">
74<iframe src="javascript:void(0)" frameborder="0"
75 name="MSearchResults" id="MSearchResults">
76</iframe>
77</div>
78
79<div class="header">
80 <div class="summary">
81<a href="#nested-classes">Classes</a> &#124;
82<a href="#namespaces">Namespaces</a> &#124;
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]83<a href="#typedef-members">Typedefs</a> &#124;
84<a href="#func-members">Functions</a> </div>
85 <div class="headertitle">
86<div class="title">document.h File Reference</div> </div>
87</div><!--header-->
88<div class="contents">
89<div class="textblock"><code>#include &quot;<a class="el" href="reader_8h_source.html">reader.h</a>&quot;</code><br />
miloyipbed133e2014-09-03 01:43:26 +0000[diff] [blame]90<code>#include &quot;internal/meta.h&quot;</code><br />
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]91<code>#include &quot;internal/strfunc.h&quot;</code><br />
miloyip6dee2ec2016-02-20 13:47:23 +0000[diff] [blame]92<code>#include &quot;memorystream.h&quot;</code><br />
93<code>#include &quot;encodedstream.h&quot;</code><br />
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]94<code>#include &lt;new&gt;</code><br />
miloyip8232e902016-07-29 07:38:24 +0000[diff] [blame]95<code>#include &lt;limits&gt;</code><br />
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]96<code>#include &lt;iterator&gt;</code><br />
97</div>
98<p><a href="document_8h_source.html">Go to the source code of this file.</a></p>
99<table class="memberdecls">
100<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
101Classes</h2></td></tr>
102<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_value.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;</a></td></tr>
103<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a JSON value. Use Value for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. <a href="classrapidjson_1_1_generic_value.html#details">More...</a><br /></td></tr>
104<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip85916f42015-07-20 09:01:07 +0000[diff] [blame]105<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_document.html">rapidjson::GenericDocument&lt; Encoding, Allocator, StackAllocator &gt;</a></td></tr>
106<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A document for parsing JSON text as DOM. <a href="classrapidjson_1_1_generic_document.html#details">More...</a><br /></td></tr>
107<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]108<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_member.html">rapidjson::GenericMember&lt; Encoding, Allocator &gt;</a></td></tr>
109<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name-value pair in a JSON object value. <a href="structrapidjson_1_1_generic_member.html#details">More...</a><br /></td></tr>
110<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_member_iterator.html">rapidjson::GenericMemberIterator&lt; Const, Encoding, Allocator &gt;</a></td></tr>
112<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Constant) member iterator for a JSON object value <a href="classrapidjson_1_1_generic_member_iterator.html#details">More...</a><br /></td></tr>
113<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_string_ref.html">rapidjson::GenericStringRef&lt; CharType &gt;</a></td></tr>
115<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference to a constant string (not taking a copy) <a href="structrapidjson_1_1_generic_string_ref.html#details">More...</a><br /></td></tr>
116<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]117<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_array.html">rapidjson::GenericArray&lt; Const, ValueT &gt;</a></td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000[diff] [blame]118<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_array.html#details">More...</a><br /></td></tr>
119<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]120<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_object.html">rapidjson::GenericObject&lt; Const, ValueT &gt;</a></td></tr>
miloyipaa0ba022016-02-23 01:41:56 +0000[diff] [blame]121<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of object type. <a href="classrapidjson_1_1_generic_object.html#details">More...</a><br /></td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000[diff] [blame]122<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]123<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_value.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;</a></td></tr>
124<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a JSON value. Use Value for <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding and default allocator. <a href="classrapidjson_1_1_generic_value.html#details">More...</a><br /></td></tr>
125<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_value_1_1_number_1_1_i.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;::Number::I</a></td></tr>
127<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidjson_1_1_generic_value_1_1_number_1_1_u.html">rapidjson::GenericValue&lt; Encoding, Allocator &gt;::Number::U</a></td></tr>
129<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_document.html">rapidjson::GenericDocument&lt; Encoding, Allocator, StackAllocator &gt;</a></td></tr>
131<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A document for parsing JSON text as DOM. <a href="classrapidjson_1_1_generic_document.html#details">More...</a><br /></td></tr>
132<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]133<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_array.html">rapidjson::GenericArray&lt; Const, ValueT &gt;</a></td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000[diff] [blame]134<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of array type. <a href="classrapidjson_1_1_generic_array.html#details">More...</a><br /></td></tr>
135<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]136<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_object.html">rapidjson::GenericObject&lt; Const, ValueT &gt;</a></td></tr>
miloyipaa0ba022016-02-23 01:41:56 +0000[diff] [blame]137<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper class for accessing Value of object type. <a href="classrapidjson_1_1_generic_object.html#details">More...</a><br /></td></tr>
miloyip0c8e6ea2016-02-19 14:35:24 +0000[diff] [blame]138<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]139</table><table class="memberdecls">
140<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
141Namespaces</h2></td></tr>
142<tr class="memitem:namespacerapidjson"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html">rapidjson</a></td></tr>
143<tr class="memdesc:namespacerapidjson"><td class="mdescLeft">&#160;</td><td class="mdescRight">main RapidJSON namespace <br /></td></tr>
144<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
145</table><table class="memberdecls">
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]146<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
147Typedefs</h2></td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]148<tr class="memitem:aa65fc9fb381b2cbc54f98673eadd6505"><td class="memItemLeft" align="right" valign="top"><a id="aa65fc9fb381b2cbc54f98673eadd6505"></a>
miloyip82f40732016-02-02 10:23:26 +0000[diff] [blame]149typedef GenericValue&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#aa65fc9fb381b2cbc54f98673eadd6505">rapidjson::Value</a></td></tr>
150<tr class="memdesc:aa65fc9fb381b2cbc54f98673eadd6505"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classrapidjson_1_1_generic_value.html" title="Represents a JSON value. Use Value for UTF8 encoding and default allocator. ">GenericValue</a> with <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding. <br /></td></tr>
151<tr class="separator:aa65fc9fb381b2cbc54f98673eadd6505"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]152<tr class="memitem:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="memItemLeft" align="right" valign="top"><a id="ace11b5b575baf1cccd5ba5f8586dcdc8"></a>
miloyip82f40732016-02-02 10:23:26 +0000[diff] [blame]153typedef GenericDocument&lt; UTF8&lt;&gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">rapidjson::Document</a></td></tr>
154<tr class="memdesc:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classrapidjson_1_1_generic_document.html" title="A document for parsing JSON text as DOM. ">GenericDocument</a> with <a class="el" href="structrapidjson_1_1_u_t_f8.html" title="UTF-8 encoding. ">UTF8</a> encoding. <br /></td></tr>
155<tr class="separator:ace11b5b575baf1cccd5ba5f8586dcdc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]156</table><table class="memberdecls">
157<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
158Functions</h2></td></tr>
159<tr class="memitem:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
160<tr class="memitem:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#aa6b9fd9f6aa49405a574c362ba9af6b5">rapidjson::StringRef</a> (const CharType *str)</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]161<tr class="memdesc:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a character pointer as constant string. <a href="namespacerapidjson.html#aa6b9fd9f6aa49405a574c362ba9af6b5">More...</a><br /></td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]162<tr class="separator:aa6b9fd9f6aa49405a574c362ba9af6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<tr class="memitem:a578c51ab574a50a9c760b9da7c7562f2"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
164<tr class="memitem:a578c51ab574a50a9c760b9da7c7562f2"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#a578c51ab574a50a9c760b9da7c7562f2">rapidjson::StringRef</a> (const CharType *str, size_t length)</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]165<tr class="memdesc:a578c51ab574a50a9c760b9da7c7562f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a character pointer as constant string. <a href="namespacerapidjson.html#a578c51ab574a50a9c760b9da7c7562f2">More...</a><br /></td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]166<tr class="separator:a578c51ab574a50a9c760b9da7c7562f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:af94951529a5d51e8c4e6e770bb707c1f"><td class="memTemplParams" colspan="2">template&lt;typename CharType &gt; </td></tr>
168<tr class="memitem:af94951529a5d51e8c4e6e770bb707c1f"><td class="memTemplItemLeft" align="right" valign="top">GenericStringRef&lt; CharType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacerapidjson.html#af94951529a5d51e8c4e6e770bb707c1f">rapidjson::StringRef</a> (const std::basic_string&lt; CharType &gt; &amp;str)</td></tr>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]169<tr class="memdesc:af94951529a5d51e8c4e6e770bb707c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark a string object as constant string. <a href="namespacerapidjson.html#af94951529a5d51e8c4e6e770bb707c1f">More...</a><br /></td></tr>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]170<tr class="separator:af94951529a5d51e8c4e6e770bb707c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
171</table>
172</div><!-- contents -->
173</div><!-- doc-content -->
174<!-- HTML footer for doxygen 1.8.7-->
175<!-- start footer part -->
176<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
177 <ul>
miloyipe7b707b2017-07-11 02:36:28 +0000[diff] [blame]178 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_32fb88e4d38e67d524aa70efbc36f66b.html">rapidjson</a></li><li class="navelem"><a class="el" href="document_8h.html">document.h</a></li>
miloyip8b488a82014-08-20 07:23:21 +0000[diff] [blame]179 </ul>
180</div>
miloyip6ea4c182015-04-07 09:25:04 +0000[diff] [blame]181</body>
miloyip52826762015-04-26 13:43:32 +0000[diff] [blame]182</html>