forked from Tencent/rapidjson
/
md_doc_stream.html
476 lines (474 loc) · 45 KB
/
md_doc_stream.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<!-- HTML header for doxygen 1.8.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<title>RapidJSON: Stream</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygenextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="topbanner"><a href="https://github.com/Tencent/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('md_doc_stream.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Stream </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#MemoryStreams">Memory Streams</a><ul><li class="level2"><a href="#StringStream">StringStream (Input)</a></li>
<li class="level2"><a href="#StringBuffer">StringBuffer (Output)</a></li>
</ul>
</li>
<li class="level1"><a href="#FileStreams">File Streams</a><ul><li class="level2"><a href="#FileReadStream">FileReadStream (Input)</a></li>
<li class="level2"><a href="#FileWriteStream">FileWriteStream (Output)</a></li>
</ul>
</li>
<li class="level1"><a href="#iostreamWrapper">iostream Wrapper</a><ul><li class="level2"><a href="#IStreamWrapper">IStreamWrapper</a></li>
<li class="level2"><a href="#OStreamWrapper">OStreamWrapper</a></li>
</ul>
</li>
<li class="level1"><a href="#EncodedStreams">Encoded Streams</a><ul><li class="level2"><a href="#EncodedInputStream">EncodedInputStream</a></li>
<li class="level2"><a href="#EncodedOutputStream">EncodedOutputStream</a></li>
<li class="level2"><a href="#AutoUTFInputStream">AutoUTFInputStream</a></li>
<li class="level2"><a href="#AutoUTFOutputStream">AutoUTFOutputStream</a></li>
</ul>
</li>
<li class="level1"><a href="#CustomStream">Custom Stream</a><ul><li class="level2"><a href="#ExampleIStreamWrapper">Example: istream wrapper</a></li>
<li class="level2"><a href="#ExampleOStreamWrapper">Example: ostream wrapper</a></li>
</ul>
</li>
<li class="level1"><a href="#Summary">Summary</a></li>
</ul>
</div>
<div class="textblock"><p>In RapidJSON, <code><a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">rapidjson::Stream</a></code> is a concept for reading/writing JSON. Here we'll first show you how to use provided streams. And then see how to create a custom stream.</p>
<h1><a class="anchor" id="MemoryStreams"></a>
Memory Streams</h1>
<p>Memory streams store JSON in memory.</p>
<h2><a class="anchor" id="StringStream"></a>
StringStream (Input)</h2>
<p><code>StringStream</code> is the most basic input stream. It represents a complete, read-only JSON stored in memory. It is defined in <code><a class="el" href="rapidjson_8h.html" title="common definitions and configuration">rapidjson/rapidjson.h</a></code>.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="document_8h.html">rapidjson/document.h</a>"</span> <span class="comment">// will include "rapidjson/rapidjson.h"</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> json[] = <span class="stringliteral">"[1, 2, 3, 4]"</span>;</div>
<div class="line"><a class="code" href="structrapidjson_1_1_generic_string_stream.html">StringStream</a> s(json);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a>(s);</div>
</div><!-- fragment --><p>Since this is very common usage, <code>Document::Parse(const char*)</code> is provided to do exactly the same as above:</p>
<div class="fragment"><div class="line"><span class="comment">// ...</span></div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> json[] = <span class="stringliteral">"[1, 2, 3, 4]"</span>;</div>
<div class="line"><a class="code" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#aea842b533a858c9a3861451ad9e8642c">Parse</a>(json);</div>
</div><!-- fragment --><p>Note that, <code>StringStream</code> is a typedef of <code>GenericStringStream<UTF8<> ></code>, user may use another encodings to represent the character set of the stream.</p>
<h2><a class="anchor" id="StringBuffer"></a>
StringBuffer (Output)</h2>
<p><code>StringBuffer</code> is a simple output stream. It allocates a memory buffer for writing the whole JSON. Use <code>GetString()</code> to obtain the buffer.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "rapidjson/stringbuffer.h"</span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/writer.h></span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="namespacerapidjson.html#ac0765ea91f41539645c4b78689d03f21">StringBuffer</a> buffer;</div>
<div class="line">Writer<StringBuffer> writer(buffer);</div>
<div class="line">d.Accept(writer);</div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span>* output = buffer.GetString();</div>
</div><!-- fragment --><p>When the buffer is full, it will increases the capacity automatically. The default capacity is 256 characters (256 bytes for UTF8, 512 bytes for UTF16, etc.). User can provide an allocator and an initial capacity.</p>
<div class="fragment"><div class="line"><a class="code" href="namespacerapidjson.html#ac0765ea91f41539645c4b78689d03f21">StringBuffer</a> buffer1(0, 1024); <span class="comment">// Use its allocator, initial size = 1024</span></div>
<div class="line"><a class="code" href="namespacerapidjson.html#ac0765ea91f41539645c4b78689d03f21">StringBuffer</a> buffer2(allocator, 1024);</div>
</div><!-- fragment --><p>By default, <code>StringBuffer</code> will instantiate an internal allocator.</p>
<p>Similarly, <code>StringBuffer</code> is a typedef of <code>GenericStringBuffer<UTF8<> ></code>.</p>
<h1><a class="anchor" id="FileStreams"></a>
File Streams</h1>
<p>When parsing a JSON from file, you may read the whole JSON into memory and use <code>StringStream</code> above.</p>
<p>However, if the JSON is big, or memory is limited, you can use <code>FileReadStream</code>. It only read a part of JSON from file into buffer, and then let the part be parsed. If it runs out of characters in the buffer, it will read the next part from file.</p>
<h2><a class="anchor" id="FileReadStream"></a>
FileReadStream (Input)</h2>
<p><code>FileReadStream</code> reads the file via a <code>FILE</code> pointer. And user need to provide a buffer.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "rapidjson/filereadstream.h"</span></div>
<div class="line"><span class="preprocessor">#include <cstdio></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line">FILE* fp = fopen(<span class="stringliteral">"big.json"</span>, <span class="stringliteral">"rb"</span>); <span class="comment">// non-Windows use "r"</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">char</span> readBuffer[65536];</div>
<div class="line"><a class="code" href="classrapidjson_1_1_file_read_stream.html">FileReadStream</a> is(fp, readBuffer, <span class="keyword">sizeof</span>(readBuffer));</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a>(is);</div>
<div class="line"> </div>
<div class="line">fclose(fp);</div>
</div><!-- fragment --><p>Different from string streams, <code>FileReadStream</code> is byte stream. It does not handle encodings. If the file is not UTF-8, the byte stream can be wrapped in a <code>EncodedInputStream</code>. We will discuss more about this later in this tutorial.</p>
<p>Apart from reading file, user can also use <code>FileReadStream</code> to read <code>stdin</code>.</p>
<h2><a class="anchor" id="FileWriteStream"></a>
FileWriteStream (Output)</h2>
<p><code>FileWriteStream</code> is buffered output stream. Its usage is very similar to <code>FileReadStream</code>.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "rapidjson/filewritestream.h"</span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/writer.h></span></div>
<div class="line"><span class="preprocessor">#include <cstdio></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#aea842b533a858c9a3861451ad9e8642c">Parse</a>(json);</div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"> </div>
<div class="line">FILE* fp = fopen(<span class="stringliteral">"output.json"</span>, <span class="stringliteral">"wb"</span>); <span class="comment">// non-Windows use "w"</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">char</span> writeBuffer[65536];</div>
<div class="line"><a class="code" href="classrapidjson_1_1_file_write_stream.html">FileWriteStream</a> os(fp, writeBuffer, <span class="keyword">sizeof</span>(writeBuffer));</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_writer.html">Writer<FileWriteStream></a> writer(os);</div>
<div class="line">d.Accept(writer);</div>
<div class="line"> </div>
<div class="line">fclose(fp);</div>
</div><!-- fragment --><p>It can also redirect the output to <code>stdout</code>.</p>
<h1><a class="anchor" id="iostreamWrapper"></a>
iostream Wrapper</h1>
<p>Due to users' requests, RapidJSON also provides official wrappers for <code>std::basic_istream</code> and <code>std::basic_ostream</code>. However, please note that the performance will be much lower than the other streams above.</p>
<h2><a class="anchor" id="IStreamWrapper"></a>
IStreamWrapper</h2>
<p><code>IStreamWrapper</code> wraps any class derived from <code>std::istream</code>, such as <code>std::istringstream</code>, <code>std::stringstream</code>, <code>std::ifstream</code>, <code>std::fstream</code>, into RapidJSON's input stream.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="document_8h.html">rapidjson/document.h</a>></span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/istreamwrapper.h></span></div>
<div class="line"><span class="preprocessor">#include <fstream></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"><span class="keyword">using namespace </span>std;</div>
<div class="line"> </div>
<div class="line">ifstream ifs(<span class="stringliteral">"test.json"</span>);</div>
<div class="line"><a class="code" href="classrapidjson_1_1_basic_i_stream_wrapper.html">IStreamWrapper</a> isw(ifs);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a>(isw);</div>
</div><!-- fragment --><p>For classes derived from <code>std::wistream</code>, use <code>WIStreamWrapper</code>.</p>
<h2><a class="anchor" id="OStreamWrapper"></a>
OStreamWrapper</h2>
<p>Similarly, <code>OStreamWrapper</code> wraps any class derived from <code>std::ostream</code>, such as <code>std::ostringstream</code>, <code>std::stringstream</code>, <code>std::ofstream</code>, <code>std::fstream</code>, into RapidJSON's input stream.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="document_8h.html">rapidjson/document.h</a>></span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/ostreamwrapper.h></span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/writer.h></span></div>
<div class="line"><span class="preprocessor">#include <fstream></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"><span class="keyword">using namespace </span>std;</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#aea842b533a858c9a3861451ad9e8642c">Parse</a>(json);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"> </div>
<div class="line">ofstream ofs(<span class="stringliteral">"output.json"</span>);</div>
<div class="line"><a class="code" href="classrapidjson_1_1_basic_o_stream_wrapper.html">OStreamWrapper</a> osw(ofs);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_writer.html">Writer<OStreamWrapper></a> writer(osw);</div>
<div class="line">d.Accept(writer);</div>
</div><!-- fragment --><p>For classes derived from <code>std::wostream</code>, use <code>WOStreamWrapper</code>.</p>
<h1><a class="anchor" id="EncodedStreams"></a>
Encoded Streams</h1>
<p>Encoded streams do not contain JSON itself, but they wrap byte streams to provide basic encoding/decoding function.</p>
<p>As mentioned above, UTF-8 byte streams can be read directly. However, UTF-16 and UTF-32 have endian issue. To handle endian correctly, it needs to convert bytes into characters (e.g. <code>wchar_t</code> for UTF-16) while reading, and characters into bytes while writing.</p>
<p>Besides, it also need to handle <a href="http://en.wikipedia.org/wiki/Byte_order_mark">byte order mark (BOM)</a>. When reading from a byte stream, it is needed to detect or just consume the BOM if exists. When writing to a byte stream, it can optionally write BOM.</p>
<p>If the encoding of stream is known during compile-time, you may use <code>EncodedInputStream</code> and <code>EncodedOutputStream</code>. If the stream can be UTF-8, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE JSON, and it is only known in runtime, you may use <code>AutoUTFInputStream</code> and <code>AutoUTFOutputStream</code>. These streams are defined in <code><a class="el" href="encodedstream_8h_source.html">rapidjson/encodedstream.h</a></code>.</p>
<p>Note that, these encoded streams can be applied to streams other than file. For example, you may have a file in memory, or a custom byte stream, be wrapped in encoded streams.</p>
<h2><a class="anchor" id="EncodedInputStream"></a>
EncodedInputStream</h2>
<p><code>EncodedInputStream</code> has two template parameters. The first one is a <code>Encoding</code> class, such as <code>UTF8</code>, <code>UTF16LE</code>, defined in <code><a class="el" href="encodings_8h_source.html">rapidjson/encodings.h</a></code>. The second one is the class of stream to be wrapped.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="document_8h.html">rapidjson/document.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "rapidjson/filereadstream.h"</span> <span class="comment">// FileReadStream</span></div>
<div class="line"><span class="preprocessor">#include "rapidjson/encodedstream.h"</span> <span class="comment">// EncodedInputStream</span></div>
<div class="line"><span class="preprocessor">#include <cstdio></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line">FILE* fp = fopen(<span class="stringliteral">"utf16le.json"</span>, <span class="stringliteral">"rb"</span>); <span class="comment">// non-Windows use "r"</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">char</span> readBuffer[256];</div>
<div class="line"><a class="code" href="classrapidjson_1_1_file_read_stream.html">FileReadStream</a> bis(fp, readBuffer, <span class="keyword">sizeof</span>(readBuffer));</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_encoded_input_stream.html">EncodedInputStream<UTF16LE<></a>, <a class="code" href="classrapidjson_1_1_file_read_stream.html">FileReadStream</a>> eis(bis); <span class="comment">// wraps bis into eis</span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d; <span class="comment">// Document is GenericDocument<UTF8<> > </span></div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a><0, <a class="code" href="structrapidjson_1_1_u_t_f16_l_e.html">UTF16LE<></a> >(eis); <span class="comment">// Parses UTF-16LE file into UTF-8 in memory</span></div>
<div class="line"> </div>
<div class="line">fclose(fp);</div>
</div><!-- fragment --><h2><a class="anchor" id="EncodedOutputStream"></a>
EncodedOutputStream</h2>
<p><code>EncodedOutputStream</code> is similar but it has a <code>bool putBOM</code> parameter in the constructor, controlling whether to write BOM into output byte stream.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "rapidjson/filewritestream.h"</span> <span class="comment">// FileWriteStream</span></div>
<div class="line"><span class="preprocessor">#include "rapidjson/encodedstream.h"</span> <span class="comment">// EncodedOutputStream</span></div>
<div class="line"><span class="preprocessor">#include <rapidjson/writer.h></span></div>
<div class="line"><span class="preprocessor">#include <cstdio></span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">Document</a> d; <span class="comment">// Document is GenericDocument<UTF8<> > </span></div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"> </div>
<div class="line">FILE* fp = fopen(<span class="stringliteral">"output_utf32le.json"</span>, <span class="stringliteral">"wb"</span>); <span class="comment">// non-Windows use "w"</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">char</span> writeBuffer[256];</div>
<div class="line">FileWriteStream bos(fp, writeBuffer, <span class="keyword">sizeof</span>(writeBuffer));</div>
<div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> EncodedOutputStream<UTF32LE<>, FileWriteStream> OutputStream;</div>
<div class="line">OutputStream eos(bos, <span class="keyword">true</span>); <span class="comment">// Write BOM</span></div>
<div class="line"> </div>
<div class="line">Writer<OutputStream, UTF8<>, UTF32LE<>> writer(eos);</div>
<div class="line">d.Accept(writer); <span class="comment">// This generates UTF32-LE file from UTF-8 in memory</span></div>
<div class="line"> </div>
<div class="line">fclose(fp);</div>
</div><!-- fragment --><h2><a class="anchor" id="AutoUTFInputStream"></a>
AutoUTFInputStream</h2>
<p>Sometimes an application may want to handle all supported JSON encoding. <code>AutoUTFInputStream</code> will detection encoding by BOM first. If BOM is unavailable, it will use characteristics of valid JSON to make detection. If neither method success, it falls back to the UTF type provided in constructor.</p>
<p>Since the characters (code units) may be 8-bit, 16-bit or 32-bit. <code>AutoUTFInputStream</code> requires a character type which can hold at least 32-bit. We may use <code>unsigned</code>, as in the template parameter:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include "<a class="code" href="document_8h.html">rapidjson/document.h</a>"</span></div>
<div class="line"><span class="preprocessor">#include "rapidjson/filereadstream.h"</span> <span class="comment">// FileReadStream</span></div>
<div class="line"><span class="preprocessor">#include "rapidjson/encodedstream.h"</span> <span class="comment">// AutoUTFInputStream</span></div>
<div class="line"><span class="preprocessor">#include <cstdio></span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line">FILE* fp = fopen(<span class="stringliteral">"any.json"</span>, <span class="stringliteral">"rb"</span>); <span class="comment">// non-Windows use "r"</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">char</span> readBuffer[256];</div>
<div class="line"><a class="code" href="classrapidjson_1_1_file_read_stream.html">FileReadStream</a> bis(fp, readBuffer, <span class="keyword">sizeof</span>(readBuffer));</div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_auto_u_t_f_input_stream.html">AutoUTFInputStream<unsigned, FileReadStream></a> eis(bis); <span class="comment">// wraps bis into eis</span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="classrapidjson_1_1_generic_document.html">Document</a> d; <span class="comment">// Document is GenericDocument<UTF8<> > </span></div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a><0, <a class="code" href="structrapidjson_1_1_auto_u_t_f.html">AutoUTF<unsigned></a> >(eis); <span class="comment">// This parses any UTF file into UTF-8 in memory</span></div>
<div class="line"> </div>
<div class="line">fclose(fp);</div>
</div><!-- fragment --><p>When specifying the encoding of stream, uses <code>AutoUTF<CharType></code> as in <code>ParseStream()</code> above.</p>
<p>You can obtain the type of UTF via <code>UTFType GetType()</code>. And check whether a BOM is found by <code>HasBOM()</code></p>
<h2><a class="anchor" id="AutoUTFOutputStream"></a>
AutoUTFOutputStream</h2>
<p>Similarly, to choose encoding for output during runtime, we can use <code>AutoUTFOutputStream</code>. This class is not automatic <em>per se</em>. You need to specify the UTF type and whether to write BOM in runtime.</p>
<div class="fragment"><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerapidjson.html">rapidjson</a>;</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> WriteJSONFile(FILE* fp, <a class="code" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a> type, <span class="keywordtype">bool</span> putBOM, <span class="keyword">const</span> <a class="code" href="classrapidjson_1_1_generic_document.html">Document</a>& d) {</div>
<div class="line"> <span class="keywordtype">char</span> writeBuffer[256];</div>
<div class="line"> <a class="code" href="classrapidjson_1_1_file_write_stream.html">FileWriteStream</a> bos(fp, writeBuffer, <span class="keyword">sizeof</span>(writeBuffer));</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">typedef</span> <a class="code" href="classrapidjson_1_1_auto_u_t_f_output_stream.html">AutoUTFOutputStream<unsigned, FileWriteStream></a> OutputStream;</div>
<div class="line"> OutputStream eos(bos, type, putBOM);</div>
<div class="line"> </div>
<div class="line"> <a class="code" href="classrapidjson_1_1_writer.html">Writer<OutputStream, UTF8<></a>, <a class="code" href="structrapidjson_1_1_auto_u_t_f.html">AutoUTF<></a> > writer;</div>
<div class="line"> d.Accept(writer);</div>
<div class="line">}</div>
</div><!-- fragment --><p><code>AutoUTFInputStream</code> and <code>AutoUTFOutputStream</code> is more convenient than <code>EncodedInputStream</code> and <code>EncodedOutputStream</code>. They just incur a little bit runtime overheads.</p>
<h1><a class="anchor" id="CustomStream"></a>
Custom Stream</h1>
<p>In addition to memory/file streams, user can create their own stream classes which fits RapidJSON's API. For example, you may create network stream, stream from compressed file, etc.</p>
<p>RapidJSON combines different types using templates. A class containing all required interface can be a stream. The Stream interface is defined in comments of <code><a class="el" href="rapidjson_8h.html" title="common definitions and configuration">rapidjson/rapidjson.h</a></code>:</p>
<div class="fragment"><div class="line">concept <a class="code" href="classrapidjson_1_1_stream.html">Stream</a> {</div>
<div class="line"> <span class="keyword">typename</span> Ch; <span class="comment">//!< Character type of the stream.</span></div>
<div class="line"><span class="comment"></span><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Read the current character from stream without moving the read cursor.</span></div>
<div class="line"><span class="comment"></span> Ch Peek() <span class="keyword">const</span>;</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Read the current character from stream and moving the read cursor to next character.</span></div>
<div class="line"><span class="comment"></span> Ch Take();</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Get the current read cursor.</span></div>
<div class="line"><span class="comment"> //! \return Number of characters read from start.</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">size_t</span> Tell();</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Begin writing operation at the current read pointer.</span></div>
<div class="line"><span class="comment"> //! \return The begin writer pointer.</span></div>
<div class="line"><span class="comment"></span> Ch* PutBegin();</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Write a character.</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">void</span> Put(Ch c);</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! Flush the buffer.</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">void</span> Flush();</div>
<div class="line"><span class="comment"></span> </div>
<div class="line"><span class="comment"> //! End the writing operation.</span></div>
<div class="line"><span class="comment"> //! \param begin The begin write pointer returned by PutBegin().</span></div>
<div class="line"><span class="comment"> //! \return Number of characters written.</span></div>
<div class="line"><span class="comment"></span> <span class="keywordtype">size_t</span> PutEnd(Ch* begin);</div>
<div class="line">}</div>
</div><!-- fragment --><p>For input stream, they must implement <code>Peek()</code>, <code>Take()</code> and <code>Tell()</code>. For output stream, they must implement <code>Put()</code> and <code>Flush()</code>. There are two special interface, <code>PutBegin()</code> and <code>PutEnd()</code>, which are only for <em>in situ</em> parsing. Normal streams do not implement them. However, if the interface is not needed for a particular stream, it is still need to a dummy implementation, otherwise will generate compilation error.</p>
<h2><a class="anchor" id="ExampleIStreamWrapper"></a>
Example: istream wrapper</h2>
<p>The following example is a simple wrapper of <code>std::istream</code>, which only implements 3 functions.</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>MyIStreamWrapper {</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <span class="keyword">typedef</span> <span class="keywordtype">char</span> Ch;</div>
<div class="line"> </div>
<div class="line"> MyIStreamWrapper(std::istream& is) : is_(is) {</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> Ch Peek()<span class="keyword"> const </span>{ <span class="comment">// 1</span></div>
<div class="line"> <span class="keywordtype">int</span> c = is_.peek();</div>
<div class="line"> <span class="keywordflow">return</span> c == std::char_traits<char>::eof() ? <span class="charliteral">'\0'</span> : (Ch)c;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> Ch Take() { <span class="comment">// 2</span></div>
<div class="line"> <span class="keywordtype">int</span> c = is_.get();</div>
<div class="line"> <span class="keywordflow">return</span> c == std::char_traits<char>::eof() ? <span class="charliteral">'\0'</span> : (Ch)c;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordtype">size_t</span> Tell()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<span class="keywordtype">size_t</span>)is_.tellg(); } <span class="comment">// 3</span></div>
<div class="line"> </div>
<div class="line"> Ch* PutBegin() { assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"> <span class="keywordtype">void</span> Put(Ch) { assert(<span class="keyword">false</span>); }</div>
<div class="line"> <span class="keywordtype">void</span> Flush() { assert(<span class="keyword">false</span>); }</div>
<div class="line"> <span class="keywordtype">size_t</span> PutEnd(Ch*) { assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"> </div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line"> MyIStreamWrapper(<span class="keyword">const</span> MyIStreamWrapper&);</div>
<div class="line"> MyIStreamWrapper& operator=(<span class="keyword">const</span> MyIStreamWrapper&);</div>
<div class="line"> </div>
<div class="line"> std::istream& is_;</div>
<div class="line">};</div>
</div><!-- fragment --><p>User can use it to wrap instances of <code>std::stringstream</code>, <code>std::ifstream</code>.</p>
<div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span>* json = <span class="stringliteral">"[1,2,3,4]"</span>;</div>
<div class="line">std::stringstream ss(json);</div>
<div class="line">MyIStreamWrapper is(ss);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">Document</a> d;</div>
<div class="line">d.<a class="code" href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">ParseStream</a>(is);</div>
</div><!-- fragment --><p>Note that, this implementation may not be as efficient as RapidJSON's memory or file streams, due to internal overheads of the standard library.</p>
<h2><a class="anchor" id="ExampleOStreamWrapper"></a>
Example: ostream wrapper</h2>
<p>The following example is a simple wrapper of <code>std::istream</code>, which only implements 2 functions.</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>MyOStreamWrapper {</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line"> <span class="keyword">typedef</span> <span class="keywordtype">char</span> Ch;</div>
<div class="line"> </div>
<div class="line"> MyOStreamWrapper(std::ostream& os) : os_(os) {</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> Ch Peek()<span class="keyword"> const </span>{ assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> <span class="charliteral">'\0'</span>; }</div>
<div class="line"> Ch Take() { assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> <span class="charliteral">'\0'</span>; }</div>
<div class="line"> <span class="keywordtype">size_t</span> Tell()<span class="keyword"> const </span>{ }</div>
<div class="line"> </div>
<div class="line"> Ch* PutBegin() { assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"> <span class="keywordtype">void</span> Put(Ch c) { os_.put(c); } <span class="comment">// 1</span></div>
<div class="line"> <span class="keywordtype">void</span> Flush() { os_.flush(); } <span class="comment">// 2</span></div>
<div class="line"> <span class="keywordtype">size_t</span> PutEnd(Ch*) { assert(<span class="keyword">false</span>); <span class="keywordflow">return</span> 0; }</div>
<div class="line"> </div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line"> MyOStreamWrapper(<span class="keyword">const</span> MyOStreamWrapper&);</div>
<div class="line"> MyOStreamWrapper& operator=(<span class="keyword">const</span> MyOStreamWrapper&);</div>
<div class="line"> </div>
<div class="line"> std::ostream& os_;</div>
<div class="line">};</div>
</div><!-- fragment --><p>User can use it to wrap instances of <code>std::stringstream</code>, <code>std::ofstream</code>.</p>
<div class="fragment"><div class="line"><a class="code" href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">Document</a> d;</div>
<div class="line"><span class="comment">// ...</span></div>
<div class="line"> </div>
<div class="line">std::stringstream ss;</div>
<div class="line">MyOStreamWrapper os(ss);</div>
<div class="line"> </div>
<div class="line">Writer<MyOStreamWrapper> writer(os);</div>
<div class="line">d.Accept(writer);</div>
</div><!-- fragment --><p>Note that, this implementation may not be as efficient as RapidJSON's memory or file streams, due to internal overheads of the standard library.</p>
<h1><a class="anchor" id="Summary"></a>
Summary</h1>
<p>This section describes stream classes available in RapidJSON. Memory streams are simple. File stream can reduce the memory required during JSON parsing and generation, if the JSON is stored in file system. Encoded streams converts between byte streams and character streams. Finally, user may create custom streams using a simple interface. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<div class="ttc" id="aclassrapidjson_1_1_stream_html"><div class="ttname"><a href="classrapidjson_1_1_stream.html">Stream</a></div><div class="ttdoc">Concept for reading and writing characters.</div></div>
<div class="ttc" id="aclassrapidjson_1_1_basic_o_stream_wrapper_html"><div class="ttname"><a href="classrapidjson_1_1_basic_o_stream_wrapper.html">rapidjson::BasicOStreamWrapper</a></div><div class="ttdoc">Wrapper of std::basic_ostream into RapidJSON's Stream concept.</div><div class="ttdef"><b>Definition:</b> ostreamwrapper.h:45</div></div>
<div class="ttc" id="adocument_8h_html"><div class="ttname"><a href="document_8h.html">document.h</a></div></div>
<div class="ttc" id="aclassrapidjson_1_1_encoded_input_stream_html"><div class="ttname"><a href="classrapidjson_1_1_encoded_input_stream.html">rapidjson::EncodedInputStream</a></div><div class="ttdoc">Input byte stream wrapper with a statically bound encoding.</div><div class="ttdef"><b>Definition:</b> encodedstream.h:39</div></div>
<div class="ttc" id="astructrapidjson_1_1_generic_string_stream_html"><div class="ttname"><a href="structrapidjson_1_1_generic_string_stream.html">rapidjson::GenericStringStream</a></div><div class="ttdoc">Read-only string stream.</div><div class="ttdef"><b>Definition:</b> fwd.h:47</div></div>
<div class="ttc" id="aclassrapidjson_1_1_generic_document_html_a3ae97682cf04685c7db9d89ebc399b85"><div class="ttname"><a href="classrapidjson_1_1_generic_document.html#a3ae97682cf04685c7db9d89ebc399b85">rapidjson::GenericDocument::ParseStream</a></div><div class="ttdeci">GenericDocument & ParseStream(InputStream &is)</div><div class="ttdoc">Parse JSON text from an input stream (with Encoding conversion)</div><div class="ttdef"><b>Definition:</b> document.h:2626</div></div>
<div class="ttc" id="aclassrapidjson_1_1_file_write_stream_html"><div class="ttname"><a href="classrapidjson_1_1_file_write_stream.html">rapidjson::FileWriteStream</a></div><div class="ttdoc">Wrapper of C file stream for output using fwrite().</div><div class="ttdef"><b>Definition:</b> filewritestream.h:32</div></div>
<div class="ttc" id="aclassrapidjson_1_1_file_read_stream_html"><div class="ttname"><a href="classrapidjson_1_1_file_read_stream.html">rapidjson::FileReadStream</a></div><div class="ttdoc">File byte stream for input using fread().</div><div class="ttdef"><b>Definition:</b> filereadstream.h:34</div></div>
<div class="ttc" id="aclassrapidjson_1_1_basic_i_stream_wrapper_html"><div class="ttname"><a href="classrapidjson_1_1_basic_i_stream_wrapper.html">rapidjson::BasicIStreamWrapper</a></div><div class="ttdoc">Wrapper of std::basic_istream into RapidJSON's Stream concept.</div><div class="ttdef"><b>Definition:</b> istreamwrapper.h:49</div></div>
<div class="ttc" id="astructrapidjson_1_1_auto_u_t_f_html"><div class="ttname"><a href="structrapidjson_1_1_auto_u_t_f.html">rapidjson::AutoUTF</a></div><div class="ttdoc">Dynamically select encoding according to stream's runtime-specified UTF encoding type.</div><div class="ttdef"><b>Definition:</b> encodings.h:615</div></div>
<div class="ttc" id="aclassrapidjson_1_1_generic_document_html_aea842b533a858c9a3861451ad9e8642c"><div class="ttname"><a href="classrapidjson_1_1_generic_document.html#aea842b533a858c9a3861451ad9e8642c">rapidjson::GenericDocument::Parse</a></div><div class="ttdeci">GenericDocument & Parse(const typename SourceEncoding::Ch *str)</div><div class="ttdoc">Parse JSON text from a read-only string (with Encoding conversion)</div><div class="ttdef"><b>Definition:</b> document.h:2692</div></div>
<div class="ttc" id="anamespacerapidjson_html_ac0765ea91f41539645c4b78689d03f21"><div class="ttname"><a href="namespacerapidjson.html#ac0765ea91f41539645c4b78689d03f21">rapidjson::StringBuffer</a></div><div class="ttdeci">GenericStringBuffer< UTF8< char >, CrtAllocator > StringBuffer</div><div class="ttdoc">String buffer with UTF8 encoding.</div><div class="ttdef"><b>Definition:</b> fwd.h:59</div></div>
<div class="ttc" id="aclassrapidjson_1_1_generic_document_html"><div class="ttname"><a href="classrapidjson_1_1_generic_document.html">rapidjson::GenericDocument</a></div><div class="ttdoc">A document for parsing JSON text as DOM.</div><div class="ttdef"><b>Definition:</b> document.h:69</div></div>
<div class="ttc" id="aclassrapidjson_1_1_writer_html"><div class="ttname"><a href="classrapidjson_1_1_writer.html">rapidjson::Writer</a></div><div class="ttdoc">JSON writer.</div><div class="ttdef"><b>Definition:</b> fwd.h:95</div></div>
<div class="ttc" id="anamespacerapidjson_html_a4aacabc0f8cea1cd628f466d890773eb"><div class="ttname"><a href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">rapidjson::UTFType</a></div><div class="ttdeci">UTFType</div><div class="ttdoc">Runtime-specified UTF encoding type of a stream.</div><div class="ttdef"><b>Definition:</b> encodings.h:603</div></div>
<div class="ttc" id="anamespacerapidjson_html_ace11b5b575baf1cccd5ba5f8586dcdc8"><div class="ttname"><a href="namespacerapidjson.html#ace11b5b575baf1cccd5ba5f8586dcdc8">rapidjson::Document</a></div><div class="ttdeci">GenericDocument< UTF8<> > Document</div><div class="ttdoc">GenericDocument with UTF8 encoding.</div><div class="ttdef"><b>Definition:</b> document.h:2873</div></div>
<div class="ttc" id="aclassrapidjson_1_1_auto_u_t_f_output_stream_html"><div class="ttname"><a href="classrapidjson_1_1_auto_u_t_f_output_stream.html">rapidjson::AutoUTFOutputStream</a></div><div class="ttdoc">Output stream wrapper with dynamically bound encoding and automatic encoding detection.</div><div class="ttdef"><b>Definition:</b> encodedstream.h:233</div></div>
<div class="ttc" id="anamespacerapidjson_html"><div class="ttname"><a href="namespacerapidjson.html">rapidjson</a></div><div class="ttdoc">main RapidJSON namespace</div><div class="ttdef"><b>Definition:</b> rapidjson.h:409</div></div>
<div class="ttc" id="aclassrapidjson_1_1_auto_u_t_f_input_stream_html"><div class="ttname"><a href="classrapidjson_1_1_auto_u_t_f_input_stream.html">rapidjson::AutoUTFInputStream</a></div><div class="ttdoc">Input stream wrapper with dynamically bound encoding and automatic encoding detection.</div><div class="ttdef"><b>Definition:</b> encodedstream.h:135</div></div>
<div class="ttc" id="astructrapidjson_1_1_u_t_f16_l_e_html"><div class="ttname"><a href="structrapidjson_1_1_u_t_f16_l_e.html">rapidjson::UTF16LE</a></div><div class="ttdoc">UTF-16 little endian encoding.</div><div class="ttdef"><b>Definition:</b> encodings.h:342</div></div>
<!-- HTML footer for doxygen 1.8.7-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
</ul>
</div>
</body>
</html>