blob: f92b60ccfbc41304f33e61d02234e554bbcf6a1d [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::FileReadStream 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_read_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_read_stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::FileReadStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>File byte stream for input using fread().
<a href="classrapidjson_1_1_file_read_stream.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="filereadstream_8h_source.html">filereadstream.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:a4a5f34875b40d22def206c9a09ecd929"><td class="memItemLeft" align="right" valign="top"><a id="a4a5f34875b40d22def206c9a09ecd929"></a>
typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a></td></tr>
<tr class="memdesc:a4a5f34875b40d22def206c9a09ecd929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Character type (byte). <br /></td></tr>
<tr class="separator:a4a5f34875b40d22def206c9a09ecd929"><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:a72b610ada5d86e8977a2bc1f2f4c0808"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_file_read_stream.html#a72b610ada5d86e8977a2bc1f2f4c0808">FileReadStream</a> (std::FILE *fp, char *buffer, size_t bufferSize)</td></tr>
<tr class="memdesc:a72b610ada5d86e8977a2bc1f2f4c0808"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classrapidjson_1_1_file_read_stream.html#a72b610ada5d86e8977a2bc1f2f4c0808">More...</a><br /></td></tr>
<tr class="separator:a72b610ada5d86e8977a2bc1f2f4c0808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1ae71d3abf9de0da0fcd02f4a4a91e1"><td class="memItemLeft" align="right" valign="top"><a id="ac1ae71d3abf9de0da0fcd02f4a4a91e1"></a>
<a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Peek</b> () const</td></tr>
<tr class="separator:ac1ae71d3abf9de0da0fcd02f4a4a91e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96ccdf2feca81ad57ccfd489ffeaf84b"><td class="memItemLeft" align="right" valign="top"><a id="a96ccdf2feca81ad57ccfd489ffeaf84b"></a>
<a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a>&#160;</td><td class="memItemRight" valign="bottom"><b>Take</b> ()</td></tr>
<tr class="separator:a96ccdf2feca81ad57ccfd489ffeaf84b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a100ae611dab44b2533e3a13d409c8234"><td class="memItemLeft" align="right" valign="top"><a id="a100ae611dab44b2533e3a13d409c8234"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Tell</b> () const</td></tr>
<tr class="separator:a100ae611dab44b2533e3a13d409c8234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a581c9287a3d0df4db997276be40c1d29"><td class="memItemLeft" align="right" valign="top"><a id="a581c9287a3d0df4db997276be40c1d29"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Put</b> (<a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a>)</td></tr>
<tr class="separator:a581c9287a3d0df4db997276be40c1d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b3ae0fe7ad88d8c9c1fac7854d1d7ec"><td class="memItemLeft" align="right" valign="top"><a id="a1b3ae0fe7ad88d8c9c1fac7854d1d7ec"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Flush</b> ()</td></tr>
<tr class="separator:a1b3ae0fe7ad88d8c9c1fac7854d1d7ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5230a74fccebd3bc41f5e455e3cf7777"><td class="memItemLeft" align="right" valign="top"><a id="a5230a74fccebd3bc41f5e455e3cf7777"></a>
<a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>PutBegin</b> ()</td></tr>
<tr class="separator:a5230a74fccebd3bc41f5e455e3cf7777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3160ea8b9906840ef690a07784b97acf"><td class="memItemLeft" align="right" valign="top"><a id="a3160ea8b9906840ef690a07784b97acf"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>PutEnd</b> (<a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a> *)</td></tr>
<tr class="separator:a3160ea8b9906840ef690a07784b97acf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a905873a05053d1415f73c5c05c732b32"><td class="memItemLeft" align="right" valign="top"><a id="a905873a05053d1415f73c5c05c732b32"></a>
const <a class="el" href="classrapidjson_1_1_file_read_stream.html#a4a5f34875b40d22def206c9a09ecd929">Ch</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>Peek4</b> () const</td></tr>
<tr class="separator:a905873a05053d1415f73c5c05c732b32"><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>File byte stream for input using fread(). </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><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a72b610ada5d86e8977a2bc1f2f4c0808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72b610ada5d86e8977a2bc1f2f4c0808">&#9670;&nbsp;</a></span>FileReadStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rapidjson::FileReadStream::FileReadStream </td>
<td>(</td>
<td class="paramtype">std::FILE *&#160;</td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>bufferSize</em>&#160;</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">fp</td><td>File pointer opened for read. </td></tr>
<tr><td class="paramname">buffer</td><td>user-supplied buffer. </td></tr>
<tr><td class="paramname">bufferSize</td><td>size of buffer in bytes. Must &gt;=4 bytes. </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="filereadstream_8h_source.html">filereadstream.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_read_stream.html">FileReadStream</a></li>
</ul>
</div>
</body>
</html>