<!-- 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.13"/> <title>RapidJSON: rapidjson::AutoUTFOutputStream< CharType, OutputByteStream > 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"> $(document).ready(initResizable); </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"> $(document).ready(function() { init_search(); }); </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/miloyip/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.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </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"> $(document).ready(function(){initNavTree('classrapidjson_1_1_auto_u_t_f_output_stream.html','');}); </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_output_stream-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">rapidjson::AutoUTFOutputStream< CharType, OutputByteStream > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>Output stream wrapper with dynamically bound encoding and automatic encoding detection. <a href="classrapidjson_1_1_auto_u_t_f_output_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:aaf40884d8f4fbf24ea040d3363c9967e"><td class="memItemLeft" align="right" valign="top"><a id="aaf40884d8f4fbf24ea040d3363c9967e"></a> typedef CharType </td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr> <tr class="separator:aaf40884d8f4fbf24ea040d3363c9967e"><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:a39c828ee4c5b052df7338ec7fda1a17d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_auto_u_t_f_output_stream.html#a39c828ee4c5b052df7338ec7fda1a17d">AutoUTFOutputStream</a> (OutputByteStream &os, <a class="el" href="namespacerapidjson.html#a4aacabc0f8cea1cd628f466d890773eb">UTFType</a> type, bool putBOM)</td></tr> <tr class="memdesc:a39c828ee4c5b052df7338ec7fda1a17d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a39c828ee4c5b052df7338ec7fda1a17d">More...</a><br /></td></tr> <tr class="separator:a39c828ee4c5b052df7338ec7fda1a17d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae01c4c0e6ac78b9bc875a9e73c63fd05"><td class="memItemLeft" align="right" valign="top"><a id="ae01c4c0e6ac78b9bc875a9e73c63fd05"></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:ae01c4c0e6ac78b9bc875a9e73c63fd05"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a11ab92b78f15ccb20917887f06d6de66"><td class="memItemLeft" align="right" valign="top"><a id="a11ab92b78f15ccb20917887f06d6de66"></a> void </td><td class="memItemRight" valign="bottom"><b>Put</b> (Ch c)</td></tr> <tr class="separator:a11ab92b78f15ccb20917887f06d6de66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a04746e5fa16007b2cbe4be5f8d68940d"><td class="memItemLeft" align="right" valign="top"><a id="a04746e5fa16007b2cbe4be5f8d68940d"></a> void </td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr> <tr class="separator:a04746e5fa16007b2cbe4be5f8d68940d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a89e2fba1e92b4f1408744934fcb56881"><td class="memItemLeft" align="right" valign="top"><a id="a89e2fba1e92b4f1408744934fcb56881"></a> Ch </td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr> <tr class="separator:a89e2fba1e92b4f1408744934fcb56881"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0fd284bc102b7802bf5541a3169d912e"><td class="memItemLeft" align="right" valign="top"><a id="a0fd284bc102b7802bf5541a3169d912e"></a> Ch </td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr> <tr class="separator:a0fd284bc102b7802bf5541a3169d912e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac6c7dadb3851cf9e49c55273dd89937c"><td class="memItemLeft" align="right" valign="top"><a id="ac6c7dadb3851cf9e49c55273dd89937c"></a> size_t </td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr> <tr class="separator:ac6c7dadb3851cf9e49c55273dd89937c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad3c65d2c5f94590add9bd743f09c0c63"><td class="memItemLeft" align="right" valign="top"><a id="ad3c65d2c5f94590add9bd743f09c0c63"></a> Ch * </td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr> <tr class="separator:ad3c65d2c5f94590add9bd743f09c0c63"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0348cb8d01546573894371d60aaaea94"><td class="memItemLeft" align="right" valign="top"><a id="a0348cb8d01546573894371d60aaaea94"></a> size_t </td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (Ch *)</td></tr> <tr class="separator:a0348cb8d01546573894371d60aaaea94"><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 OutputByteStream><br /> class rapidjson::AutoUTFOutputStream< CharType, OutputByteStream ></h3> <p>Output 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 writing. </td></tr> <tr><td class="paramname">OutputByteStream</td><td>type of output byte stream to be wrapped. </td></tr> </table> </dd> </dl> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a39c828ee4c5b052df7338ec7fda1a17d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a39c828ee4c5b052df7338ec7fda1a17d">◆ </a></span>AutoUTFOutputStream()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename CharType , typename OutputByteStream > </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_output_stream.html">rapidjson::AutoUTFOutputStream</a>< CharType, OutputByteStream >::<a class="el" href="classrapidjson_1_1_auto_u_t_f_output_stream.html">AutoUTFOutputStream</a> </td> <td>(</td> <td class="paramtype">OutputByteStream & </td> <td class="paramname"><em>os</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>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>putBOM</em> </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">os</td><td>output stream to be wrapped. </td></tr> <tr><td class="paramname">type</td><td>UTF encoding type. </td></tr> <tr><td class="paramname">putBOM</td><td>Whether to write BOM at the beginning of 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_output_stream.html">AutoUTFOutputStream</a></li> </ul> </div> </body> </html>