blob: c0e4165aa4557f9d71b4c8d5cf0a5527bef7c946 [file] [log] [blame]
<!-- 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: rapidjson::GenericStreamWrapper&lt; InputStream, Encoding &gt; Class Template Reference</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&amp;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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classrapidjson_1_1_generic_stream_wrapper.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="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classrapidjson_1_1_generic_stream_wrapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::GenericStreamWrapper&lt; InputStream, Encoding &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> Wrapper.
<a href="classrapidjson_1_1_generic_stream_wrapper.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="stream_8h_source.html">stream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for rapidjson::GenericStreamWrapper&lt; InputStream, Encoding &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classrapidjson_1_1_generic_stream_wrapper.png" usemap="#rapidjson::GenericStreamWrapper_3C_20InputStream_2C_20Encoding_20_3E_map" alt=""/>
<map id="rapidjson::GenericStreamWrapper_3C_20InputStream_2C_20Encoding_20_3E_map" name="rapidjson::GenericStreamWrapper_3C_20InputStream_2C_20Encoding_20_3E_map">
<area href="classrapidjson_1_1_cursor_stream_wrapper.html" title="Cursor stream wrapper for counting line and column number if error exists." alt="rapidjson::CursorStreamWrapper&lt; InputStream, Encoding &gt;" shape="rect" coords="0,56,355,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac07ed61df8db2bd4a5e713e613b06bdb"><td class="memItemLeft" align="right" valign="top"><a id="ac07ed61df8db2bd4a5e713e613b06bdb"></a>
typedef Encoding::Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:ac07ed61df8db2bd4a5e713e613b06bdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac04401f8176175ddf758848ddfdb6cb5"><td class="memItemLeft" align="right" valign="top"><a id="ac04401f8176175ddf758848ddfdb6cb5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>GenericStreamWrapper</b> (InputStream &amp;is)</td></tr>
<tr class="separator:ac04401f8176175ddf758848ddfdb6cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a0a9ee10cf6ab4f58cbb7e261d679fa"><td class="memItemLeft" align="right" valign="top"><a id="a0a0a9ee10cf6ab4f58cbb7e261d679fa"></a>
Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
<tr class="separator:a0a0a9ee10cf6ab4f58cbb7e261d679fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78083bbd93f63183f51b49d1cd0c445f"><td class="memItemLeft" align="right" valign="top"><a id="a78083bbd93f63183f51b49d1cd0c445f"></a>
Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
<tr class="separator:a78083bbd93f63183f51b49d1cd0c445f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7c6c1b49dad4488906c27bc56bf04a5"><td class="memItemLeft" align="right" valign="top"><a id="ae7c6c1b49dad4488906c27bc56bf04a5"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Tell</b> ()</td></tr>
<tr class="separator:ae7c6c1b49dad4488906c27bc56bf04a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6c6dcbc789147e1caab79561a10934a"><td class="memItemLeft" align="right" valign="top"><a id="ac6c6dcbc789147e1caab79561a10934a"></a>
Ch *&#160;</td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
<tr class="separator:ac6c6dcbc789147e1caab79561a10934a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d0412d9c6ca4b025a0ffb7268264549"><td class="memItemLeft" align="right" valign="top"><a id="a6d0412d9c6ca4b025a0ffb7268264549"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Put</b> (Ch ch)</td></tr>
<tr class="separator:a6d0412d9c6ca4b025a0ffb7268264549"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c9f0b055206530559d5aa167672f592"><td class="memItemLeft" align="right" valign="top"><a id="a7c9f0b055206530559d5aa167672f592"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:a7c9f0b055206530559d5aa167672f592"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abff782cf275f8f4151a115affe1d815e"><td class="memItemLeft" align="right" valign="top"><a id="abff782cf275f8f4151a115affe1d815e"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (Ch *ch)</td></tr>
<tr class="separator:abff782cf275f8f4151a115affe1d815e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9478f917376bf218b104fc75e02fd1f7"><td class="memItemLeft" align="right" valign="top"><a id="a9478f917376bf218b104fc75e02fd1f7"></a>
const Ch *&#160;</td><td class="memItemRight" valign="bottom"><b>Peek4</b> () const</td></tr>
<tr class="separator:a9478f917376bf218b104fc75e02fd1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15b67cf080337745d7bd3bf4988eed7a"><td class="memItemLeft" align="right" valign="top"><a id="a15b67cf080337745d7bd3bf4988eed7a"></a>
<a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetType</b> () const</td></tr>
<tr class="separator:a15b67cf080337745d7bd3bf4988eed7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bcfb0e4e74a0cf692bf4e7042106b8a"><td class="memItemLeft" align="right" valign="top"><a id="a3bcfb0e4e74a0cf692bf4e7042106b8a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>HasBOM</b> () const</td></tr>
<tr class="separator:a3bcfb0e4e74a0cf692bf4e7042106b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a5cf3034d6761716e9ca2fe7591ed8274"><td class="memItemLeft" align="right" valign="top"><a id="a5cf3034d6761716e9ca2fe7591ed8274"></a>
InputStream &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>is_</b></td></tr>
<tr class="separator:a5cf3034d6761716e9ca2fe7591ed8274"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename InputStream, typename Encoding = UTF8&lt;&gt;&gt;<br />
class rapidjson::GenericStreamWrapper&lt; InputStream, Encoding &gt;</h3>
<p>A <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> Wrapper. </p>
<p>\tThis string stream is a wrapper for any stream by just forwarding any \treceived message to the origin stream. </p><dl class="section note"><dt>Note</dt><dd>implements <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> concept </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/rapidjson/<a class="el" href="stream_8h_source.html">stream.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.7-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacerapidjson.html">rapidjson</a></li><li class="navelem"><a class="el" href="classrapidjson_1_1_generic_stream_wrapper.html">GenericStreamWrapper</a></li>
</ul>
</div>
</body>
</html>