blob: 67ab88135d8249638331fc13a2c410e6411ce936 [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::UTF16LE&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_u_t_f16_l_e.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-static-methods">Static Public Member Functions</a> &#124;
<a href="structrapidjson_1_1_u_t_f16_l_e-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::UTF16LE&lt; CharType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>UTF-16 little endian encoding.
<a href="structrapidjson_1_1_u_t_f16_l_e.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="encodings_8h_source.html">encodings.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for rapidjson::UTF16LE&lt; CharType &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="structrapidjson_1_1_u_t_f16_l_e.png" usemap="#rapidjson::UTF16LE_3C_20CharType_20_3E_map" alt=""/>
<map id="rapidjson::UTF16LE_3C_20CharType_20_3E_map" name="rapidjson::UTF16LE_3C_20CharType_20_3E_map">
<area href="structrapidjson_1_1_u_t_f16.html" title="UTF-16 encoding." alt="rapidjson::UTF16&lt; CharType &gt;" shape="rect" coords="0,0,202,24"/>
</map>
</div></div>
<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:a4d3a271692803a71bc26f004e0505c18"><td class="memTemplParams" colspan="2"><a id="a4d3a271692803a71bc26f004e0505c18"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:a4d3a271692803a71bc26f004e0505c18"><td class="memTemplItemLeft" align="right" valign="top">static CharType&#160;</td><td class="memTemplItemRight" valign="bottom"><b>TakeBOM</b> (InputByteStream &amp;is)</td></tr>
<tr class="separator:a4d3a271692803a71bc26f004e0505c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afae56fc8dfd1bf27b27608ee41415d8c"><td class="memTemplParams" colspan="2"><a id="afae56fc8dfd1bf27b27608ee41415d8c"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:afae56fc8dfd1bf27b27608ee41415d8c"><td class="memTemplItemLeft" align="right" valign="top">static CharType&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Take</b> (InputByteStream &amp;is)</td></tr>
<tr class="separator:afae56fc8dfd1bf27b27608ee41415d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56d0c0242802d60e74ecc38b5843cdc6"><td class="memTemplParams" colspan="2"><a id="a56d0c0242802d60e74ecc38b5843cdc6"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:a56d0c0242802d60e74ecc38b5843cdc6"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>PutBOM</b> (OutputByteStream &amp;os)</td></tr>
<tr class="separator:a56d0c0242802d60e74ecc38b5843cdc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3ecd38c70fe23a0a5d8a31866cf9228"><td class="memTemplParams" colspan="2"><a id="ae3ecd38c70fe23a0a5d8a31866cf9228"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:ae3ecd38c70fe23a0a5d8a31866cf9228"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Put</b> (OutputByteStream &amp;os, CharType c)</td></tr>
<tr class="separator:ae3ecd38c70fe23a0a5d8a31866cf9228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_structrapidjson_1_1_u_t_f16"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_structrapidjson_1_1_u_t_f16')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="structrapidjson_1_1_u_t_f16.html">rapidjson::UTF16&lt; CharType &gt;</a></td></tr>
<tr class="memitem:a7f15344b8f35e341a723fa25d22e59d2 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplParams" colspan="2"><a id="a7f15344b8f35e341a723fa25d22e59d2"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:a7f15344b8f35e341a723fa25d22e59d2 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Encode</b> (OutputStream &amp;os, unsigned codepoint)</td></tr>
<tr class="separator:a7f15344b8f35e341a723fa25d22e59d2 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac8a8cdff51c647b3c3a9d7df5c2ce62 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplParams" colspan="2"><a id="aac8a8cdff51c647b3c3a9d7df5c2ce62"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:aac8a8cdff51c647b3c3a9d7df5c2ce62 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>EncodeUnsafe</b> (OutputStream &amp;os, unsigned codepoint)</td></tr>
<tr class="separator:aac8a8cdff51c647b3c3a9d7df5c2ce62 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2665394536a32c9ea76d0cc7184e52fe inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplParams" colspan="2"><a id="a2665394536a32c9ea76d0cc7184e52fe"></a>
template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:a2665394536a32c9ea76d0cc7184e52fe inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Decode</b> (InputStream &amp;is, unsigned *codepoint)</td></tr>
<tr class="separator:a2665394536a32c9ea76d0cc7184e52fe inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bfa2e9096b1596e0b3a2cc2be6c9477 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplParams" colspan="2"><a id="a9bfa2e9096b1596e0b3a2cc2be6c9477"></a>
template&lt;typename InputStream , typename OutputStream &gt; </td></tr>
<tr class="memitem:a9bfa2e9096b1596e0b3a2cc2be6c9477 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memTemplItemLeft" align="right" valign="top">static bool&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Validate</b> (InputStream &amp;is, OutputStream &amp;os)</td></tr>
<tr class="separator:a9bfa2e9096b1596e0b3a2cc2be6c9477 inherit pub_static_methods_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structrapidjson_1_1_u_t_f16"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structrapidjson_1_1_u_t_f16')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structrapidjson_1_1_u_t_f16.html">rapidjson::UTF16&lt; CharType &gt;</a></td></tr>
<tr class="memitem:a439e1dc4701cc7ae34d257ce76f5dc37 inherit pub_types_structrapidjson_1_1_u_t_f16"><td class="memItemLeft" align="right" valign="top"><a id="a439e1dc4701cc7ae34d257ce76f5dc37"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>supportUnicode</b> = 1
}</td></tr>
<tr class="separator:a439e1dc4701cc7ae34d257ce76f5dc37 inherit pub_types_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb67f53501b796b55996352a6080da54 inherit pub_types_structrapidjson_1_1_u_t_f16"><td class="memItemLeft" align="right" valign="top"><a id="acb67f53501b796b55996352a6080da54"></a>
typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:acb67f53501b796b55996352a6080da54 inherit pub_types_structrapidjson_1_1_u_t_f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structrapidjson_1_1_u_t_f16"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structrapidjson_1_1_u_t_f16')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structrapidjson_1_1_u_t_f16.html">rapidjson::UTF16&lt; CharType &gt;</a></td></tr>
<tr class="memitem:a97a1141d35742ceeedc0da87538b8790 inherit pub_methods_structrapidjson_1_1_u_t_f16"><td class="memItemLeft" align="right" valign="top"><a id="a97a1141d35742ceeedc0da87538b8790"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RAPIDJSON_STATIC_ASSERT</b> (sizeof(Ch) &gt;=2)</td></tr>
<tr class="separator:a97a1141d35742ceeedc0da87538b8790 inherit pub_methods_structrapidjson_1_1_u_t_f16"><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 = wchar_t&gt;<br />
struct rapidjson::UTF16LE&lt; CharType &gt;</h3>
<p>UTF-16 little endian encoding. </p>
</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_u_t_f16_l_e.html">UTF16LE</a></li>
</ul>
</div>
</body>
</html>