mirror of
https://github.com/Tencent/rapidjson.git
synced 2025-09-13 18:10:37 +02:00
214 lines
12 KiB
HTML
214 lines
12 KiB
HTML
<!-- 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::AutoUTFInputStream< CharType, InputByteStream > 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&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('classrapidjson_1_1_auto_u_t_f_input_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="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classrapidjson_1_1_auto_u_t_f_input_stream-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">rapidjson::AutoUTFInputStream< CharType, InputByteStream > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Input stream wrapper with dynamically bound encoding and automatic encoding detection.
|
|
<a href="classrapidjson_1_1_auto_u_t_f_input_stream.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="encodedstream_8h_source.html">encodedstream.h</a>></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:a6d9eca095f7ef8c249ebe43568d66d0e"><td class="memItemLeft" align="right" valign="top"><a id="a6d9eca095f7ef8c249ebe43568d66d0e"></a>
|
|
typedef CharType </td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
|
|
<tr class="separator:a6d9eca095f7ef8c249ebe43568d66d0e"><td class="memSeparator" colspan="2"> </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:a5c9f041a3b32bf15bc9be888a8731d35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_auto_u_t_f_input_stream.html#a5c9f041a3b32bf15bc9be888a8731d35">AutoUTFInputStream</a> (InputByteStream &is, <a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a> type=<a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eba3bda3a2e3f0ec2b7e8c5a3d5d4f60a81">kUTF8</a>)</td></tr>
|
|
<tr class="memdesc:a5c9f041a3b32bf15bc9be888a8731d35"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classrapidjson_1_1_auto_u_t_f_input_stream.html#a5c9f041a3b32bf15bc9be888a8731d35">More...</a><br /></td></tr>
|
|
<tr class="separator:a5c9f041a3b32bf15bc9be888a8731d35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3666311c98787d9ed61b9fed2f3ac983"><td class="memItemLeft" align="right" valign="top"><a id="a3666311c98787d9ed61b9fed2f3ac983"></a>
|
|
<a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a> </td><td class="memItemRight" valign="bottom"><b>GetType</b> () const</td></tr>
|
|
<tr class="separator:a3666311c98787d9ed61b9fed2f3ac983"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9934b27779fad9e36e6a85cbbaf21877"><td class="memItemLeft" align="right" valign="top"><a id="a9934b27779fad9e36e6a85cbbaf21877"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>HasBOM</b> () const</td></tr>
|
|
<tr class="separator:a9934b27779fad9e36e6a85cbbaf21877"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c5f36399d52fdc8230c25e092d4c357"><td class="memItemLeft" align="right" valign="top"><a id="a6c5f36399d52fdc8230c25e092d4c357"></a>
|
|
Ch </td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
|
|
<tr class="separator:a6c5f36399d52fdc8230c25e092d4c357"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd4074558faa530f19aeeca6339e58e4"><td class="memItemLeft" align="right" valign="top"><a id="abd4074558faa530f19aeeca6339e58e4"></a>
|
|
Ch </td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
|
|
<tr class="separator:abd4074558faa530f19aeeca6339e58e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e9b3e74895d28625fd184cf8897ed18"><td class="memItemLeft" align="right" valign="top"><a id="a1e9b3e74895d28625fd184cf8897ed18"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr>
|
|
<tr class="separator:a1e9b3e74895d28625fd184cf8897ed18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a407d1e2e7db6a547833e6b0a44162b6e"><td class="memItemLeft" align="right" valign="top"><a id="a407d1e2e7db6a547833e6b0a44162b6e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Put</b> (Ch)</td></tr>
|
|
<tr class="separator:a407d1e2e7db6a547833e6b0a44162b6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad148d858b28b501d16d68b5e5af8602e"><td class="memItemLeft" align="right" valign="top"><a id="ad148d858b28b501d16d68b5e5af8602e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
|
|
<tr class="separator:ad148d858b28b501d16d68b5e5af8602e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2706e06ffd8666c40c3a51705eef76c"><td class="memItemLeft" align="right" valign="top"><a id="ae2706e06ffd8666c40c3a51705eef76c"></a>
|
|
Ch * </td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
|
|
<tr class="separator:ae2706e06ffd8666c40c3a51705eef76c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebead5efecdc51ffd78d95ca6ca1e07b"><td class="memItemLeft" align="right" valign="top"><a id="aebead5efecdc51ffd78d95ca6ca1e07b"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (Ch *)</td></tr>
|
|
<tr class="separator:aebead5efecdc51ffd78d95ca6ca1e07b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename CharType, typename InputByteStream><br />
|
|
class rapidjson::AutoUTFInputStream< CharType, InputByteStream ></h3>
|
|
|
|
<p>Input stream wrapper with dynamically bound encoding and automatic encoding detection. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">CharType</td><td>Type of character for reading. </td></tr>
|
|
<tr><td class="paramname">InputByteStream</td><td>type of input byte stream to be wrapped. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a5c9f041a3b32bf15bc9be888a8731d35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c9f041a3b32bf15bc9be888a8731d35">◆ </a></span>AutoUTFInputStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename CharType, typename InputByteStream> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classrapidjson_1_1_auto_u_t_f_input_stream.html">rapidjson::AutoUTFInputStream</a>< CharType, InputByteStream >::<a class="el" href="classrapidjson_1_1_auto_u_t_f_input_stream.html">AutoUTFInputStream</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">InputByteStream & </td>
|
|
<td class="paramname"><em>is</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a> </td>
|
|
<td class="paramname"><em>type</em> = <code><a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eba3bda3a2e3f0ec2b7e8c5a3d5d4f60a81">kUTF8</a></code> </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">is</td><td>input stream to be wrapped. </td></tr>
|
|
<tr><td class="paramname">type</td><td>UTF encoding type if it is not detected from the stream. </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="encodedstream_8h_source.html">encodedstream.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_auto_u_t_f_input_stream.html">AutoUTFInputStream</a></li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|