| <!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/Encoder.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">Encoder.hh File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Low level support for encoding 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="Encoder_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_1Encoder.html">avro::Encoder</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The abstract base class for all Avro encoders. <a href="classavro_1_1Encoder.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:a73d301acfedf564ff033eba5ec68aa86"><td class="memItemLeft" align="right" valign="top"><a id="a73d301acfedf564ff033eba5ec68aa86"></a> |
| typedef std::shared_ptr< Encoder > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a73d301acfedf564ff033eba5ec68aa86">avro::EncoderPtr</a></td></tr> |
| <tr class="memdesc:a73d301acfedf564ff033eba5ec68aa86"><td class="mdescLeft"> </td><td class="mdescRight">Shared pointer to <a class="el" href="classavro_1_1Encoder.html" title="The abstract base class for all Avro encoders. ">Encoder</a>. <br /></td></tr> |
| <tr class="separator:a73d301acfedf564ff033eba5ec68aa86"><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:ad0158bd2fc76615b68db68d7e4f7c4f6"><td class="memItemLeft" align="right" valign="top"><a id="ad0158bd2fc76615b68db68d7e4f7c4f6"></a> |
| AVRO_DECL EncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#ad0158bd2fc76615b68db68d7e4f7c4f6">avro::binaryEncoder</a> ()</td></tr> |
| <tr class="memdesc:ad0158bd2fc76615b68db68d7e4f7c4f6"><td class="mdescLeft"> </td><td class="mdescRight">Returns an encoder that can encode binary Avro standard. <br /></td></tr> |
| <tr class="separator:ad0158bd2fc76615b68db68d7e4f7c4f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ba750d980390623baeae24bc24b286e"><td class="memItemLeft" align="right" valign="top"><a id="a1ba750d980390623baeae24bc24b286e"></a> |
| AVRO_DECL EncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a1ba750d980390623baeae24bc24b286e">avro::validatingEncoder</a> (const ValidSchema &schema, const EncoderPtr &base)</td></tr> |
| <tr class="memdesc:a1ba750d980390623baeae24bc24b286e"><td class="mdescLeft"> </td><td class="mdescRight">Returns an encoder that validates sequence of calls to an underlying <a class="el" href="classavro_1_1Encoder.html" title="The abstract base class for all Avro encoders. ">Encoder</a> against the given schema. <br /></td></tr> |
| <tr class="separator:a1ba750d980390623baeae24bc24b286e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0847ef62f42f6f0d0af28da9f7c7cf15"><td class="memItemLeft" align="right" valign="top"><a id="a0847ef62f42f6f0d0af28da9f7c7cf15"></a> |
| AVRO_DECL EncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#a0847ef62f42f6f0d0af28da9f7c7cf15">avro::jsonEncoder</a> (const ValidSchema &schema)</td></tr> |
| <tr class="memdesc:a0847ef62f42f6f0d0af28da9f7c7cf15"><td class="mdescLeft"> </td><td class="mdescRight">Returns an encoder that encodes Avro standard for JSON. <br /></td></tr> |
| <tr class="separator:a0847ef62f42f6f0d0af28da9f7c7cf15"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaa6028342a629213643d27da4a0aba5d"><td class="memItemLeft" align="right" valign="top"><a id="aaa6028342a629213643d27da4a0aba5d"></a> |
| AVRO_DECL EncoderPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html#aaa6028342a629213643d27da4a0aba5d">avro::jsonPrettyEncoder</a> (const ValidSchema &schema)</td></tr> |
| <tr class="memdesc:aaa6028342a629213643d27da4a0aba5d"><td class="mdescLeft"> </td><td class="mdescRight">Returns an encoder that encodes Avro standard for pretty printed JSON. <br /></td></tr> |
| <tr class="separator:aaa6028342a629213643d27da4a0aba5d"><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 encoding avro values. </p> |
| <p>This class has two types of funtions. One type of functions support the writing of leaf values (for example, encodeLong and encodeString). These functions have analogs in Decoder.</p> |
| <p>The other type of functions support the writing of maps and arrays. These functions are arrayStart, startItem, and arrayEnd (and similar functions for maps). Some implementations of Encoder handle the buffering required to break large maps and arrays into blocks, which is necessary for applications that want to do streaming. </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> |
