| <!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++: api/Decoder.hh File 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="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Decoder.hh File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Low level support for decoding avro values. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include "Config.hh"</code><br /> |
| <code>#include <stdint.h></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include <memory></code><br /> |
| <code>#include "ValidSchema.hh"</code><br /> |
| <code>#include "Stream.hh"</code><br /> |
| </div> |
| <p><a href="Decoder_8hh_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1Decoder.html">avro::Decoder</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classavro_1_1Decoder.html" title="Decoder is an interface implemented by every decoder capable of decoding Avro data. ">Decoder</a> is an interface implemented by every decoder capable of decoding Avro data. <a href="classavro_1_1Decoder.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1ResolvingDecoder.html">avro::ResolvingDecoder</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classavro_1_1ResolvingDecoder.html" title="ResolvingDecoder is derived from Decoder, with an additional function to obtain the field ordering of...">ResolvingDecoder</a> is derived from <a class="el" href="classavro_1_1Decoder.html">Decoder</a>, with an additional function to obtain the field ordering of fiedls within a record. <a href="classavro_1_1ResolvingDecoder.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespaceavro"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html">avro</a></td></tr> |
| <tr class="memdesc:namespaceavro"><td class="mdescLeft"> </td><td class="mdescRight">A bunch of templates and specializations for encoding and decoding specific types. <br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:a7403d421c11fed3d8aa50f412f80b7b5"><td class="memItemLeft" align="right" valign="top"><a id="a7403d421c11fed3d8aa50f412f80b7b5"></a> |
| typedef std::shared_ptr< Decoder > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a7403d421c11fed3d8aa50f412f80b7b5">avro::DecoderPtr</a></td></tr> |
| <tr class="memdesc:a7403d421c11fed3d8aa50f412f80b7b5"><td class="mdescLeft"> </td><td class="mdescRight">Shared pointer to <a class="el" href="classavro_1_1Decoder.html" title="Decoder is an interface implemented by every decoder capable of decoding Avro data. ">Decoder</a>. <br /></td></tr> |
| <tr class="separator:a7403d421c11fed3d8aa50f412f80b7b5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bd01b70008d509062d39d07d1e13bc8"><td class="memItemLeft" align="right" valign="top"><a id="a5bd01b70008d509062d39d07d1e13bc8"></a> |
| typedef std::shared_ptr< ResolvingDecoder > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a5bd01b70008d509062d39d07d1e13bc8">avro::ResolvingDecoderPtr</a></td></tr> |
| <tr class="memdesc:a5bd01b70008d509062d39d07d1e13bc8"><td class="mdescLeft"> </td><td class="mdescRight">Shared pointer to <a class="el" href="classavro_1_1ResolvingDecoder.html" title="ResolvingDecoder is derived from Decoder, with an additional function to obtain the field ordering of...">ResolvingDecoder</a>. <br /></td></tr> |
| <tr class="separator:a5bd01b70008d509062d39d07d1e13bc8"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a04f78e53cb84a0189b626e6a5726b148"><td class="memItemLeft" align="right" valign="top"><a id="a04f78e53cb84a0189b626e6a5726b148"></a> |
| AVRO_DECL DecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a04f78e53cb84a0189b626e6a5726b148">avro::binaryDecoder</a> ()</td></tr> |
| <tr class="memdesc:a04f78e53cb84a0189b626e6a5726b148"><td class="mdescLeft"> </td><td class="mdescRight">Returns an decoder that can decode binary Avro standard. <br /></td></tr> |
| <tr class="separator:a04f78e53cb84a0189b626e6a5726b148"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9408498d77f42a536074433cc541d8ae"><td class="memItemLeft" align="right" valign="top"><a id="a9408498d77f42a536074433cc541d8ae"></a> |
| AVRO_DECL DecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a9408498d77f42a536074433cc541d8ae">avro::validatingDecoder</a> (const ValidSchema &schema, const DecoderPtr &base)</td></tr> |
| <tr class="memdesc:a9408498d77f42a536074433cc541d8ae"><td class="mdescLeft"> </td><td class="mdescRight">Returns an decoder that validates sequence of calls to an underlying <a class="el" href="classavro_1_1Decoder.html" title="Decoder is an interface implemented by every decoder capable of decoding Avro data. ">Decoder</a> against the given schema. <br /></td></tr> |
| <tr class="separator:a9408498d77f42a536074433cc541d8ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ac8a9c93b0621227de3dcca383e36ff"><td class="memItemLeft" align="right" valign="top"><a id="a7ac8a9c93b0621227de3dcca383e36ff"></a> |
| AVRO_DECL DecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a7ac8a9c93b0621227de3dcca383e36ff">avro::jsonDecoder</a> (const ValidSchema &schema)</td></tr> |
| <tr class="memdesc:a7ac8a9c93b0621227de3dcca383e36ff"><td class="mdescLeft"> </td><td class="mdescRight">Returns an decoder that can decode Avro standard for JSON. <br /></td></tr> |
| <tr class="separator:a7ac8a9c93b0621227de3dcca383e36ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeef8b583abe36b25a8d2094d7a3d4b96"><td class="memItemLeft" align="right" valign="top">AVRO_DECL ResolvingDecoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#aeef8b583abe36b25a8d2094d7a3d4b96">avro::resolvingDecoder</a> (const ValidSchema &writer, const ValidSchema &reader, const DecoderPtr &base)</td></tr> |
| <tr class="memdesc:aeef8b583abe36b25a8d2094d7a3d4b96"><td class="mdescLeft"> </td><td class="mdescRight">Returns a decoder that decodes avro data from base written according to writerSchema and resolves against readerSchema. <a href="namespaceavro.html#aeef8b583abe36b25a8d2094d7a3d4b96">More...</a><br /></td></tr> |
| <tr class="separator:aeef8b583abe36b25a8d2094d7a3d4b96"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Low level support for decoding avro values. </p> |
| <p>This class has two types of funtions. One type of functions support decoding of leaf values (for example, decodeLong and decodeString). These functions have analogs in Encoder.</p> |
| <p>The other type of functions support decoding of maps and arrays. These functions are arrayStart, startItem, and arrayEnd (and similar functions for maps). </p> |
| </div></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
