blob: 97139ee67749ba86ae87408d103a4ab158ffdc0f [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::BasicOStreamWrapper&lt; StreamType &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_basic_o_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="classrapidjson_1_1_basic_o_stream_wrapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::BasicOStreamWrapper&lt; StreamType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper of <code>std::basic_ostream</code> into RapidJSON's <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> concept.
<a href="classrapidjson_1_1_basic_o_stream_wrapper.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ostreamwrapper_8h_source.html">ostreamwrapper.h</a>&gt;</code></p>
<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:a615d4f601af4c039c9087a50578226b0"><td class="memItemLeft" align="right" valign="top"><a id="a615d4f601af4c039c9087a50578226b0"></a>
typedef StreamType::char_type&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:a615d4f601af4c039c9087a50578226b0"><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:a68222d18ea4a16917b374ca53f78bbcd"><td class="memItemLeft" align="right" valign="top"><a id="a68222d18ea4a16917b374ca53f78bbcd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BasicOStreamWrapper</b> (StreamType &amp;stream)</td></tr>
<tr class="separator:a68222d18ea4a16917b374ca53f78bbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4e99bf009dd43c7e760eebae4e732ac"><td class="memItemLeft" align="right" valign="top"><a id="ae4e99bf009dd43c7e760eebae4e732ac"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Put</b> (Ch c)</td></tr>
<tr class="separator:ae4e99bf009dd43c7e760eebae4e732ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d981433f0df0fbcaed206d11642b183"><td class="memItemLeft" align="right" valign="top"><a id="a4d981433f0df0fbcaed206d11642b183"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:a4d981433f0df0fbcaed206d11642b183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3baaf203553871fbd849368e1b5526e"><td class="memItemLeft" align="right" valign="top"><a id="ac3baaf203553871fbd849368e1b5526e"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
<tr class="separator:ac3baaf203553871fbd849368e1b5526e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ea92ceb4c1fae9cdd1912f2ab07dd73"><td class="memItemLeft" align="right" valign="top"><a id="a4ea92ceb4c1fae9cdd1912f2ab07dd73"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
<tr class="separator:a4ea92ceb4c1fae9cdd1912f2ab07dd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bf51fa9e5692dceaf98b0cceba3f7e2"><td class="memItemLeft" align="right" valign="top"><a id="a6bf51fa9e5692dceaf98b0cceba3f7e2"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr>
<tr class="separator:a6bf51fa9e5692dceaf98b0cceba3f7e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d9c9c5d11e53ea486cf555fb43d6fe2"><td class="memItemLeft" align="right" valign="top"><a id="a0d9c9c5d11e53ea486cf555fb43d6fe2"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
<tr class="separator:a0d9c9c5d11e53ea486cf555fb43d6fe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e1c33024d08945a32b85aeba87dca82"><td class="memItemLeft" align="right" valign="top"><a id="a8e1c33024d08945a32b85aeba87dca82"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (char *)</td></tr>
<tr class="separator:a8e1c33024d08945a32b85aeba87dca82"><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 StreamType&gt;<br />
class rapidjson::BasicOStreamWrapper&lt; StreamType &gt;</h3>
<p>Wrapper of <code>std::basic_ostream</code> into RapidJSON's <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> concept. </p>
<p>The classes can be wrapped including but not limited to:</p>
<ul>
<li><code>std::ostringstream</code> </li>
<li><code>std::stringstream</code> </li>
<li><code>std::wpstringstream</code> </li>
<li><code>std::wstringstream</code> </li>
<li><code>std::ifstream</code> </li>
<li><code>std::fstream</code> </li>
<li><code>std::wofstream</code> </li>
<li><code>std::wfstream</code> </li>
</ul>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">StreamType</td><td>Class derived from <code>std::basic_ostream</code>. </td></tr>
</table>
</dd>
</dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/rapidjson/<a class="el" href="ostreamwrapper_8h_source.html">ostreamwrapper.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_basic_o_stream_wrapper.html">BasicOStreamWrapper</a></li>
</ul>
</div>
</body>
</html>