blob: 96eb0d3f4905363d5648271a9e14df5fc64f84a3 [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::UTF8&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_f8.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_u_t_f8-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::UTF8&lt; CharType &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>UTF-8 encoding.
<a href="structrapidjson_1_1_u_t_f8.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:a162ec39d1feea956ac7c82ee21bbe037"><td class="memItemLeft" align="right" valign="top"><a id="a162ec39d1feea956ac7c82ee21bbe037"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>supportUnicode</b> = 1
}</td></tr>
<tr class="separator:a162ec39d1feea956ac7c82ee21bbe037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f47e775d8306a647a5c9eceac4b52fc"><td class="memItemLeft" align="right" valign="top"><a id="a9f47e775d8306a647a5c9eceac4b52fc"></a>
typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:a9f47e775d8306a647a5c9eceac4b52fc"><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:ae7515b5a30ad9c565fe972e408b38135"><td class="memTemplParams" colspan="2"><a id="ae7515b5a30ad9c565fe972e408b38135"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:ae7515b5a30ad9c565fe972e408b38135"><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:ae7515b5a30ad9c565fe972e408b38135"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d4607f6c91a06881317382c31a7944d"><td class="memTemplParams" colspan="2"><a id="a2d4607f6c91a06881317382c31a7944d"></a>
template&lt;typename OutputStream &gt; </td></tr>
<tr class="memitem:a2d4607f6c91a06881317382c31a7944d"><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:a2d4607f6c91a06881317382c31a7944d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6162dbaf07a21e06ae8e48c0186c9217"><td class="memTemplParams" colspan="2"><a id="a6162dbaf07a21e06ae8e48c0186c9217"></a>
template&lt;typename InputStream &gt; </td></tr>
<tr class="memitem:a6162dbaf07a21e06ae8e48c0186c9217"><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:a6162dbaf07a21e06ae8e48c0186c9217"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bfabc54daeee1bdbfdbac3ec5f4392d"><td class="memTemplParams" colspan="2"><a id="a4bfabc54daeee1bdbfdbac3ec5f4392d"></a>
template&lt;typename InputStream , typename OutputStream &gt; </td></tr>
<tr class="memitem:a4bfabc54daeee1bdbfdbac3ec5f4392d"><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:a4bfabc54daeee1bdbfdbac3ec5f4392d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3510e51d62eed8e64f5c162003d0c7e"><td class="memItemLeft" align="right" valign="top"><a id="af3510e51d62eed8e64f5c162003d0c7e"></a>
static unsigned char&#160;</td><td class="memItemRight" valign="bottom"><b>GetRange</b> (unsigned char c)</td></tr>
<tr class="separator:af3510e51d62eed8e64f5c162003d0c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5d49ba5bb7948b1b38fdd6ea5fa026e"><td class="memTemplParams" colspan="2"><a id="ab5d49ba5bb7948b1b38fdd6ea5fa026e"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:ab5d49ba5bb7948b1b38fdd6ea5fa026e"><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:ab5d49ba5bb7948b1b38fdd6ea5fa026e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae940f0948417361aab47948b77aba3e3"><td class="memTemplParams" colspan="2"><a id="ae940f0948417361aab47948b77aba3e3"></a>
template&lt;typename InputByteStream &gt; </td></tr>
<tr class="memitem:ae940f0948417361aab47948b77aba3e3"><td class="memTemplItemLeft" align="right" valign="top">static Ch&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Take</b> (InputByteStream &amp;is)</td></tr>
<tr class="separator:ae940f0948417361aab47948b77aba3e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5843a8ff5370dd22d8ff631fef1d40e"><td class="memTemplParams" colspan="2"><a id="ac5843a8ff5370dd22d8ff631fef1d40e"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:ac5843a8ff5370dd22d8ff631fef1d40e"><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:ac5843a8ff5370dd22d8ff631fef1d40e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1bad7130f2c4af05880e92ea61a13aca"><td class="memTemplParams" colspan="2"><a id="a1bad7130f2c4af05880e92ea61a13aca"></a>
template&lt;typename OutputByteStream &gt; </td></tr>
<tr class="memitem:a1bad7130f2c4af05880e92ea61a13aca"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Put</b> (OutputByteStream &amp;os, Ch c)</td></tr>
<tr class="separator:a1bad7130f2c4af05880e92ea61a13aca"><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 = char&gt;<br />
struct rapidjson::UTF8&lt; CharType &gt;</h3>
<p>UTF-8 encoding. </p>
<p><a href="http://en.wikipedia.org/wiki/UTF-8">http://en.wikipedia.org/wiki/UTF-8</a> <a href="http://tools.ietf.org/html/rfc3629">http://tools.ietf.org/html/rfc3629</a> </p><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CharType</td><td>Code unit for storing 8-bit UTF-8 data. Default is char. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>implements <a class="el" href="classrapidjson_1_1_encoding.html" title="Concept for encoding of Unicode characters.">Encoding</a> concept </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_u_t_f8.html">UTF8</a></li>
</ul>
</div>
</body>
</html>