generic-library/rapidjson
1
0
Fork 0
mirror of https://github.com/Tencent/rapidjson.git synced 2025-09-11 09:01:06 +02:00
Code Issues Projects Releases Wiki Activity
rapidjson/classrapidjson_1_1_basic_i_stream_wrapper.html
miloyip a93947227a Automatic doxygen build
2019-09-25 06:38:37 +00:00

267 lines
14 KiB
HTML
Raw Permalink Blame History

<!-- 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::BasicIStreamWrapper&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_i_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_i_stream_wrapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::BasicIStreamWrapper&lt; StreamType &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper of <code>std::basic_istream</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_i_stream_wrapper.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="istreamwrapper_8h_source.html">istreamwrapper.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:a5fd972d8cd20b90ba0772aeebf122597"><td class="memItemLeft" align="right" valign="top"><a id="a5fd972d8cd20b90ba0772aeebf122597"></a>
typedef StreamType::char_type&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:a5fd972d8cd20b90ba0772aeebf122597"><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:a2b4e069522fa9119685f1cee836e5cfa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html#a2b4e069522fa9119685f1cee836e5cfa">BasicIStreamWrapper</a> (StreamType &amp;stream)</td></tr>
<tr class="memdesc:a2b4e069522fa9119685f1cee836e5cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classrapidjson_1_1_basic_i_stream_wrapper.html#a2b4e069522fa9119685f1cee836e5cfa">More...</a><br /></td></tr>
<tr class="separator:a2b4e069522fa9119685f1cee836e5cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd380a93ccc01d02aef95ea2a926e154"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html#acd380a93ccc01d02aef95ea2a926e154">BasicIStreamWrapper</a> (StreamType &amp;stream, char *buffer, size_t bufferSize)</td></tr>
<tr class="memdesc:acd380a93ccc01d02aef95ea2a926e154"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classrapidjson_1_1_basic_i_stream_wrapper.html#acd380a93ccc01d02aef95ea2a926e154">More...</a><br /></td></tr>
<tr class="separator:acd380a93ccc01d02aef95ea2a926e154"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfae250fbfdf7dda0ee9b3895758e767"><td class="memItemLeft" align="right" valign="top"><a id="adfae250fbfdf7dda0ee9b3895758e767"></a>
Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
<tr class="separator:adfae250fbfdf7dda0ee9b3895758e767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac803b6494e23a3432c6da1ba9cb9abdc"><td class="memItemLeft" align="right" valign="top"><a id="ac803b6494e23a3432c6da1ba9cb9abdc"></a>
Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
<tr class="separator:ac803b6494e23a3432c6da1ba9cb9abdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a298096361d0d34706ba68af0a68e389f"><td class="memItemLeft" align="right" valign="top"><a id="a298096361d0d34706ba68af0a68e389f"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr>
<tr class="separator:a298096361d0d34706ba68af0a68e389f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af020a73e0739581f784b68c1f5adb385"><td class="memItemLeft" align="right" valign="top"><a id="af020a73e0739581f784b68c1f5adb385"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Put</b> (Ch)</td></tr>
<tr class="separator:af020a73e0739581f784b68c1f5adb385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab787ec1bce9ec0e4ddc42cde173d3ab1"><td class="memItemLeft" align="right" valign="top"><a id="ab787ec1bce9ec0e4ddc42cde173d3ab1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:ab787ec1bce9ec0e4ddc42cde173d3ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5175c92fadc5278b215bad1822b62267"><td class="memItemLeft" align="right" valign="top"><a id="a5175c92fadc5278b215bad1822b62267"></a>
Ch *&#160;</td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
<tr class="separator:a5175c92fadc5278b215bad1822b62267"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06939b6b8f349a611e6dd8ed82274a76"><td class="memItemLeft" align="right" valign="top"><a id="a06939b6b8f349a611e6dd8ed82274a76"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (Ch *)</td></tr>
<tr class="separator:a06939b6b8f349a611e6dd8ed82274a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afaece8ea8d7b73abc0d4942070b41f8a"><td class="memItemLeft" align="right" valign="top"><a id="afaece8ea8d7b73abc0d4942070b41f8a"></a>
const Ch *&#160;</td><td class="memItemRight" valign="bottom"><b>Peek4</b> () const</td></tr>
<tr class="separator:afaece8ea8d7b73abc0d4942070b41f8a"><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::BasicIStreamWrapper&lt; StreamType &gt;</h3>
<p>Wrapper of <code>std::basic_istream</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::istringstream</code> </li>
<li><code>std::stringstream</code> </li>
<li><code>std::wistringstream</code> </li>
<li><code>std::wstringstream</code> </li>
<li><code>std::ifstream</code> </li>
<li><code>std::fstream</code> </li>
<li><code>std::wifstream</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_istream</code>. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2b4e069522fa9119685f1cee836e5cfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b4e069522fa9119685f1cee836e5cfa">&#9670;&nbsp;</a></span>BasicIStreamWrapper() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename StreamType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html">rapidjson::BasicIStreamWrapper</a>&lt; StreamType &gt;::<a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html">BasicIStreamWrapper</a> </td>
<td>(</td>
<td class="paramtype">StreamType &amp;&#160;</td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>stream opened for read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acd380a93ccc01d02aef95ea2a926e154"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd380a93ccc01d02aef95ea2a926e154">&#9670;&nbsp;</a></span>BasicIStreamWrapper() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename StreamType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html">rapidjson::BasicIStreamWrapper</a>&lt; StreamType &gt;::<a class="el" href="classrapidjson_1_1_basic_i_stream_wrapper.html">BasicIStreamWrapper</a> </td>
<td>(</td>
<td class="paramtype">StreamType &amp;&#160;</td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>bufferSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>stream opened for read. </td></tr>
<tr><td class="paramname">buffer</td><td>user-supplied buffer. </td></tr>
<tr><td class="paramname">bufferSize</td><td>size of buffer in bytes. Must &gt;=4 bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/rapidjson/<a class="el" href="istreamwrapper_8h_source.html">istreamwrapper.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_i_stream_wrapper.html">BasicIStreamWrapper</a></li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink