blob: fdb957201c6a1b99c7636ad3ee425df9288b7d5f [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::FileWriteStream Class 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('classrapidjson_1_1_file_write_stream.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-methods">Public Member Functions</a> &#124;
<a href="classrapidjson_1_1_file_write_stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::FileWriteStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper of C file stream for output using fwrite().
<a href="classrapidjson_1_1_file_write_stream.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="filewritestream_8h_source.html">filewritestream.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:afc606cc81f6c3709d81bf99b30566330"><td class="memItemLeft" align="right" valign="top"><a id="afc606cc81f6c3709d81bf99b30566330"></a>
typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_file_write_stream.html#afc606cc81f6c3709d81bf99b30566330">Ch</a></td></tr>
<tr class="memdesc:afc606cc81f6c3709d81bf99b30566330"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character type. Only support char. <br /></td></tr>
<tr class="separator:afc606cc81f6c3709d81bf99b30566330"><td class="memSeparator" colspan="2">&#160;</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:a9abf2078f78a30c7ad868f480e4221be"><td class="memItemLeft" align="right" valign="top"><a id="a9abf2078f78a30c7ad868f480e4221be"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FileWriteStream</b> (std::FILE *fp, char *buffer, size_t bufferSize)</td></tr>
<tr class="separator:a9abf2078f78a30c7ad868f480e4221be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a3b2b270c90f4672400d36a4f056fbc"><td class="memItemLeft" align="right" valign="top"><a id="a5a3b2b270c90f4672400d36a4f056fbc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Put</b> (char c)</td></tr>
<tr class="separator:a5a3b2b270c90f4672400d36a4f056fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e66d814422fd311a908cf2145535b99"><td class="memItemLeft" align="right" valign="top"><a id="a6e66d814422fd311a908cf2145535b99"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>PutN</b> (char c, size_t n)</td></tr>
<tr class="separator:a6e66d814422fd311a908cf2145535b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad21fb3d1318a91a1d32ce971378981e1"><td class="memItemLeft" align="right" valign="top"><a id="ad21fb3d1318a91a1d32ce971378981e1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:ad21fb3d1318a91a1d32ce971378981e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a9816245140dac55d66c24d5f21e231"><td class="memItemLeft" align="right" valign="top"><a id="a8a9816245140dac55d66c24d5f21e231"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
<tr class="separator:a8a9816245140dac55d66c24d5f21e231"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b3d198633b02a7d016b8833b4615b33"><td class="memItemLeft" align="right" valign="top"><a id="a6b3d198633b02a7d016b8833b4615b33"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
<tr class="separator:a6b3d198633b02a7d016b8833b4615b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab57d1149f396b095b1eab2154974983d"><td class="memItemLeft" align="right" valign="top"><a id="ab57d1149f396b095b1eab2154974983d"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr>
<tr class="separator:ab57d1149f396b095b1eab2154974983d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a330ab2dff49aca7015f92e699a675f11"><td class="memItemLeft" align="right" valign="top"><a id="a330ab2dff49aca7015f92e699a675f11"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
<tr class="separator:a330ab2dff49aca7015f92e699a675f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac755d1f640dc82a2359b2867ce09ac0c"><td class="memItemLeft" align="right" valign="top"><a id="ac755d1f640dc82a2359b2867ce09ac0c"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (char *)</td></tr>
<tr class="separator:ac755d1f640dc82a2359b2867ce09ac0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wrapper of C file stream for output using fwrite(). </p>
<dl class="section note"><dt>Note</dt><dd>implements <a class="el" href="classrapidjson_1_1_stream.html" title="Concept for reading and writing characters.">Stream</a> concept </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/rapidjson/<a class="el" href="filewritestream_8h_source.html">filewritestream.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_file_write_stream.html">FileWriteStream</a></li>
</ul>
</div>
</body>
</html>