Google Git
Sign in
apache/avro/refs/heads/asf-site/./docs/1.10.1/api/cpp/html/classavro_1_1Parser.html
blob: 487b8e4a057348a900ce9108e89cd7a02a653ea0 [file]
<!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"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Avro C++: avro::Parser&lt; Reader &gt; 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="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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Avro C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceavro.html">avro</a></li><li class="navelem"><a class="el" href="classavro_1_1Parser.html">Parser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classavro_1_1Parser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">avro::Parser&lt; Reader &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class that wraps a reader or ValidatingReade with an interface that uses explicit get* names instead of getValue.
<a href="classavro_1_1Parser.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Parser_8hh_source.html">Parser.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for avro::Parser&lt; Reader &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classavro_1_1Parser.png" usemap="#avro::Parser_3C_20Reader_20_3E_map" alt=""/>
<map id="avro::Parser_3C_20Reader_20_3E_map" name="avro::Parser_3C_20Reader_20_3E_map">
</map>
</div></div>
<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:afb6f0b9809b2039ca912c153e77cd712"><td class="memItemLeft" align="right" valign="top"><a id="afb6f0b9809b2039ca912c153e77cd712"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Parser</b> (const InputBuffer &amp;in)</td></tr>
<tr class="separator:afb6f0b9809b2039ca912c153e77cd712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2114aaad86211245f156537ac1975d3"><td class="memItemLeft" align="right" valign="top"><a id="ab2114aaad86211245f156537ac1975d3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1Parser.html#ab2114aaad86211245f156537ac1975d3">Parser</a> (const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &amp;schema, const InputBuffer &amp;in)</td></tr>
<tr class="memdesc:ab2114aaad86211245f156537ac1975d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor only works with ValidatingWriter. <br /></td></tr>
<tr class="separator:ab2114aaad86211245f156537ac1975d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdf9acebc9766e9764183ade9399745a"><td class="memItemLeft" align="right" valign="top"><a id="afdf9acebc9766e9764183ade9399745a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>readNull</b> ()</td></tr>
<tr class="separator:afdf9acebc9766e9764183ade9399745a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a947ffce48aced8e0a7b7ebf6145299bd"><td class="memItemLeft" align="right" valign="top"><a id="a947ffce48aced8e0a7b7ebf6145299bd"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>readBool</b> ()</td></tr>
<tr class="separator:a947ffce48aced8e0a7b7ebf6145299bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1d424b88d2c2a5492b05cd3784a86b4"><td class="memItemLeft" align="right" valign="top"><a id="aa1d424b88d2c2a5492b05cd3784a86b4"></a>
int32_t&#160;</td><td class="memItemRight" valign="bottom"><b>readInt</b> ()</td></tr>
<tr class="separator:aa1d424b88d2c2a5492b05cd3784a86b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd00c43aa92f88c616b07e51b53c4a56"><td class="memItemLeft" align="right" valign="top"><a id="acd00c43aa92f88c616b07e51b53c4a56"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readLong</b> ()</td></tr>
<tr class="separator:acd00c43aa92f88c616b07e51b53c4a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa247560a7bbb9455ac86eb7a4ad4bd20"><td class="memItemLeft" align="right" valign="top"><a id="aa247560a7bbb9455ac86eb7a4ad4bd20"></a>
float&#160;</td><td class="memItemRight" valign="bottom"><b>readFloat</b> ()</td></tr>
<tr class="separator:aa247560a7bbb9455ac86eb7a4ad4bd20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff58fc82755e11c2ff1b68cbd3e457cf"><td class="memItemLeft" align="right" valign="top"><a id="aff58fc82755e11c2ff1b68cbd3e457cf"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>readDouble</b> ()</td></tr>
<tr class="separator:aff58fc82755e11c2ff1b68cbd3e457cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fb8bad195cea514e639890bac2808e9"><td class="memItemLeft" align="right" valign="top"><a id="a2fb8bad195cea514e639890bac2808e9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>readString</b> (std::string &amp;val)</td></tr>
<tr class="separator:a2fb8bad195cea514e639890bac2808e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ce3d13cc0af5600591ccb45f193c976"><td class="memItemLeft" align="right" valign="top"><a id="a6ce3d13cc0af5600591ccb45f193c976"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>readBytes</b> (std::vector&lt; uint8_t &gt; &amp;val)</td></tr>
<tr class="separator:a6ce3d13cc0af5600591ccb45f193c976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2dc0c1a18135d9ee3c314a9852630050"><td class="memTemplParams" colspan="2"><a id="a2dc0c1a18135d9ee3c314a9852630050"></a>
template&lt;size_t N&gt; </td></tr>
<tr class="memitem:a2dc0c1a18135d9ee3c314a9852630050"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>readFixed</b> (uint8_t(&amp;val)[N])</td></tr>
<tr class="separator:a2dc0c1a18135d9ee3c314a9852630050"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91184ca8c805bfccbad3baa4cc3db0da"><td class="memTemplParams" colspan="2"><a id="a91184ca8c805bfccbad3baa4cc3db0da"></a>
template&lt;size_t N&gt; </td></tr>
<tr class="memitem:a91184ca8c805bfccbad3baa4cc3db0da"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>readFixed</b> (std::array&lt; uint8_t, N &gt; &amp;val)</td></tr>
<tr class="separator:a91184ca8c805bfccbad3baa4cc3db0da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47a05a4f3c3361e2edb7786c18e072e2"><td class="memItemLeft" align="right" valign="top"><a id="a47a05a4f3c3361e2edb7786c18e072e2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>readRecord</b> ()</td></tr>
<tr class="separator:a47a05a4f3c3361e2edb7786c18e072e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3dfb225090050b9f729b72f5063d553"><td class="memItemLeft" align="right" valign="top"><a id="ad3dfb225090050b9f729b72f5063d553"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>readRecordEnd</b> ()</td></tr>
<tr class="separator:ad3dfb225090050b9f729b72f5063d553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5e6751c53a41cf05fad92427301d037"><td class="memItemLeft" align="right" valign="top"><a id="ab5e6751c53a41cf05fad92427301d037"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readArrayBlockSize</b> ()</td></tr>
<tr class="separator:ab5e6751c53a41cf05fad92427301d037"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e0c3343628ef700057c5cb7f60aab29"><td class="memItemLeft" align="right" valign="top"><a id="a8e0c3343628ef700057c5cb7f60aab29"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readUnion</b> ()</td></tr>
<tr class="separator:a8e0c3343628ef700057c5cb7f60aab29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f866ceac9a5a87f1ccc034ee61dea3e"><td class="memItemLeft" align="right" valign="top"><a id="a2f866ceac9a5a87f1ccc034ee61dea3e"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readEnum</b> ()</td></tr>
<tr class="separator:a2f866ceac9a5a87f1ccc034ee61dea3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fc8003b810ff2ee938a2225a721b654"><td class="memItemLeft" align="right" valign="top"><a id="a2fc8003b810ff2ee938a2225a721b654"></a>
int64_t&#160;</td><td class="memItemRight" valign="bottom"><b>readMapBlockSize</b> ()</td></tr>
<tr class="separator:a2fc8003b810ff2ee938a2225a721b654"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a45c84b7374eddb68e49334401e3e28ec"><td class="memItemLeft" align="right" valign="top"><a id="a45c84b7374eddb68e49334401e3e28ec"></a>
<a class="el" href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">Type</a>&#160;</td><td class="memItemRight" valign="bottom"><b>nextType</b> (<a class="el" href="classavro_1_1Parser.html">Parser</a>&lt; <a class="el" href="classavro_1_1ReaderImpl.html">ValidatingReader</a> &gt; &amp;p)</td></tr>
<tr class="separator:a45c84b7374eddb68e49334401e3e28ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97857ac667674e8e0465dfe569072feb"><td class="memItemLeft" align="right" valign="top"><a id="a97857ac667674e8e0465dfe569072feb"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>currentRecordName</b> (<a class="el" href="classavro_1_1Parser.html">Parser</a>&lt; <a class="el" href="classavro_1_1ReaderImpl.html">ValidatingReader</a> &gt; &amp;p, std::string &amp;name)</td></tr>
<tr class="separator:a97857ac667674e8e0465dfe569072feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b93b91a8959de11bb2ec3a1e3d17f86"><td class="memItemLeft" align="right" valign="top"><a id="a8b93b91a8959de11bb2ec3a1e3d17f86"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>nextFieldName</b> (<a class="el" href="classavro_1_1Parser.html">Parser</a>&lt; <a class="el" href="classavro_1_1ReaderImpl.html">ValidatingReader</a> &gt; &amp;p, std::string &amp;name)</td></tr>
<tr class="separator:a8b93b91a8959de11bb2ec3a1e3d17f86"><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;class Reader&gt;<br />
class avro::Parser&lt; Reader &gt;</h3>
<p>Class that wraps a reader or ValidatingReade with an interface that uses explicit get* names instead of getValue. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>api/<a class="el" href="Parser_8hh_source.html">Parser.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>