blob: b6f2bd233223ef2b5af1ee5f1fdf941dd1240041 [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::UTF32BE&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_f32_b_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_f32_b_e-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::UTF32BE&lt; CharType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>UTF-32 big endian encoding.
<a href="structrapidjson_1_1_u_t_f32_b_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::UTF32BE&lt; CharType &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="structrapidjson_1_1_u_t_f32_b_e.png" usemap="#rapidjson::UTF32BE_3C_20CharType_20_3E_map" alt=""/>
<map id="rapidjson::UTF32BE_3C_20CharType_20_3E_map" name="rapidjson::UTF32BE_3C_20CharType_20_3E_map">
<area href="structrapidjson_1_1_u_t_f32.html" title="UTF-32 encoding." alt="rapidjson::UTF32&lt; CharType &gt;" shape="rect" coords="0,0,203,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:a36bca05acf96452fdebb12ba36b17c63"><td class="memTemplParams" colspan="2"><a id="a36bca05acf96452fdebb12ba36b17c63"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:a36bca05acf96452fdebb12ba36b17c63"><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:a36bca05acf96452fdebb12ba36b17c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af92223e22d792426cc2e296ffa8c2464"><td class="memTemplParams" colspan="2"><a id="af92223e22d792426cc2e296ffa8c2464"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:af92223e22d792426cc2e296ffa8c2464"><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:af92223e22d792426cc2e296ffa8c2464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b3bd7fde8445fa7cf4260a22a1886bd"><td class="memTemplParams" colspan="2"><a id="a2b3bd7fde8445fa7cf4260a22a1886bd"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:a2b3bd7fde8445fa7cf4260a22a1886bd"><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:a2b3bd7fde8445fa7cf4260a22a1886bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a9ff04ee3e835839fffd99037d4615"><td class="memTemplParams" colspan="2"><a id="ab9a9ff04ee3e835839fffd99037d4615"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:ab9a9ff04ee3e835839fffd99037d4615"><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:ab9a9ff04ee3e835839fffd99037d4615"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_methods_structrapidjson_1_1_u_t_f32"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_structrapidjson_1_1_u_t_f32')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="structrapidjson_1_1_u_t_f32.html">rapidjson::UTF32&lt; CharType &gt;</a></td></tr>
<tr class="memitem:a3b0052772242f79904a11c1fd69ba7a8 inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memTemplParams" colspan="2"><a id="a3b0052772242f79904a11c1fd69ba7a8"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:a3b0052772242f79904a11c1fd69ba7a8 inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><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:a3b0052772242f79904a11c1fd69ba7a8 inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6bd3135243287cb9d8cb26401cddfed inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memTemplParams" colspan="2"><a id="af6bd3135243287cb9d8cb26401cddfed"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:af6bd3135243287cb9d8cb26401cddfed inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><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:af6bd3135243287cb9d8cb26401cddfed inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a196e9da00366c3fce8ca5b56634d110a inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memTemplParams" colspan="2"><a id="a196e9da00366c3fce8ca5b56634d110a"></a>
template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:a196e9da00366c3fce8ca5b56634d110a inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><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:a196e9da00366c3fce8ca5b56634d110a inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51a4dccb78915bba67217ace12d294db inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><td class="memTemplParams" colspan="2"><a id="a51a4dccb78915bba67217ace12d294db"></a>
template&lt;typename InputStream , typename OutputStream &gt; </td></tr>
<tr class="memitem:a51a4dccb78915bba67217ace12d294db inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><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:a51a4dccb78915bba67217ace12d294db inherit pub_static_methods_structrapidjson_1_1_u_t_f32"><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_f32"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structrapidjson_1_1_u_t_f32')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structrapidjson_1_1_u_t_f32.html">rapidjson::UTF32&lt; CharType &gt;</a></td></tr>
<tr class="memitem:a65443b00cba1bb95baf55025108d6a54 inherit pub_types_structrapidjson_1_1_u_t_f32"><td class="memItemLeft" align="right" valign="top"><a id="a65443b00cba1bb95baf55025108d6a54"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>supportUnicode</b> = 1
}</td></tr>
<tr class="separator:a65443b00cba1bb95baf55025108d6a54 inherit pub_types_structrapidjson_1_1_u_t_f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acea97ff3d1b722b88c5faa72cfd4385e inherit pub_types_structrapidjson_1_1_u_t_f32"><td class="memItemLeft" align="right" valign="top"><a id="acea97ff3d1b722b88c5faa72cfd4385e"></a>
typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:acea97ff3d1b722b88c5faa72cfd4385e inherit pub_types_structrapidjson_1_1_u_t_f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structrapidjson_1_1_u_t_f32"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structrapidjson_1_1_u_t_f32')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structrapidjson_1_1_u_t_f32.html">rapidjson::UTF32&lt; CharType &gt;</a></td></tr>
<tr class="memitem:ac297f89fdab70c22b19f7db769affe05 inherit pub_methods_structrapidjson_1_1_u_t_f32"><td class="memItemLeft" align="right" valign="top"><a id="ac297f89fdab70c22b19f7db769affe05"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RAPIDJSON_STATIC_ASSERT</b> (sizeof(Ch) &gt;=4)</td></tr>
<tr class="separator:ac297f89fdab70c22b19f7db769affe05 inherit pub_methods_structrapidjson_1_1_u_t_f32"><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 = unsigned&gt;<br />
struct rapidjson::UTF32BE&lt; CharType &gt;</h3>
<p>UTF-32 big 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_f32_b_e.html">UTF32BE</a></li>
</ul>
</div>
</body>
</html>