blob: ae04ff8bff6839ac68a4dba2ee4d1f579881f7cb [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::AutoUTF&lt; CharType &gt; Struct 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('structrapidjson_1_1_auto_u_t_f.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-static-methods">Static Public Member Functions</a> &#124;
<a href="structrapidjson_1_1_auto_u_t_f-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::AutoUTF&lt; CharType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Dynamically select encoding according to stream's runtime-specified UTF encoding type.
<a href="structrapidjson_1_1_auto_u_t_f.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="encodings_8h_source.html">encodings.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:aa9095b9e85767361f9a0ae5527dba101"><td class="memItemLeft" align="right" valign="top"><a id="aa9095b9e85767361f9a0ae5527dba101"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>supportUnicode</b> = 1
}</td></tr>
<tr class="separator:aa9095b9e85767361f9a0ae5527dba101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ba58f529fad9b33dc419b12ee13844d"><td class="memItemLeft" align="right" valign="top"><a id="a8ba58f529fad9b33dc419b12ee13844d"></a>
typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:a8ba58f529fad9b33dc419b12ee13844d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4c9a9fd8666f1269997e40b587175c26"><td class="memTemplParams" colspan="2"><a id="a4c9a9fd8666f1269997e40b587175c26"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:a4c9a9fd8666f1269997e40b587175c26"><td class="memTemplItemLeft" align="right" valign="top">static RAPIDJSON_FORCEINLINE void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Encode</b> (OutputStream &amp;os, unsigned codepoint)</td></tr>
<tr class="separator:a4c9a9fd8666f1269997e40b587175c26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac55057f44fd139ccf5044b7503c441c3"><td class="memTemplParams" colspan="2"><a id="ac55057f44fd139ccf5044b7503c441c3"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:ac55057f44fd139ccf5044b7503c441c3"><td class="memTemplItemLeft" align="right" valign="top">static RAPIDJSON_FORCEINLINE void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>EncodeUnsafe</b> (OutputStream &amp;os, unsigned codepoint)</td></tr>
<tr class="separator:ac55057f44fd139ccf5044b7503c441c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad722cc64bca2bacddd1029d8980c4ac2"><td class="memTemplParams" colspan="2"><a id="ad722cc64bca2bacddd1029d8980c4ac2"></a>
template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:ad722cc64bca2bacddd1029d8980c4ac2"><td class="memTemplItemLeft" align="right" valign="top">static RAPIDJSON_FORCEINLINE bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Decode</b> (InputStream &amp;is, unsigned *codepoint)</td></tr>
<tr class="separator:ad722cc64bca2bacddd1029d8980c4ac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5454260f314ab07a9f747d268a79e70a"><td class="memTemplParams" colspan="2"><a id="a5454260f314ab07a9f747d268a79e70a"></a>
template&lt;typename InputStream , typename OutputStream &gt; </td></tr>
<tr class="memitem:a5454260f314ab07a9f747d268a79e70a"><td class="memTemplItemLeft" align="right" valign="top">static RAPIDJSON_FORCEINLINE bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Validate</b> (InputStream &amp;is, OutputStream &amp;os)</td></tr>
<tr class="separator:a5454260f314ab07a9f747d268a79e70a"><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 CharType&gt;<br />
struct rapidjson::AutoUTF&lt; CharType &gt;</h3>
<p>Dynamically select encoding according to stream's runtime-specified UTF encoding type. </p>
<dl class="section note"><dt>Note</dt><dd>This class can be used with AutoUTFInputtStream and <a class="el" href="classrapidjson_1_1_auto_u_t_f_output_stream.html" title="Output stream wrapper with dynamically bound encoding and automatic encoding detection.">AutoUTFOutputStream</a>, which provides GetType(). </dd></dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/rapidjson/<a class="el" href="encodings_8h_source.html">encodings.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="structrapidjson_1_1_auto_u_t_f.html">AutoUTF</a></li>
</ul>
</div>
</body>
</html>