Google Git
Sign in
apache/avro/refs/heads/asf-site/./docs/1.10.1/api/cpp/html/Encoder_8hh_source.html
blob: 4d10799dad68b9a79f1c2afbb83c9c4463a91630 [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++: api/Encoder.hh Source File</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="headertitle">
<div class="title">Encoder.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="Encoder_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * https://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef avro_Encoder_hh__</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define avro_Encoder_hh__</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;Config.hh&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;ValidSchema.hh&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;Stream.hh&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceavro.html">avro</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classavro_1_1Encoder.html"> 52</a></span>&#160;<span class="keyword">class </span>AVRO_DECL <a class="code" href="classavro_1_1Encoder.html">Encoder</a> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classavro_1_1Encoder.html">Encoder</a>() { };</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> init(<a class="code" href="classavro_1_1OutputStream.html">OutputStream</a>&amp; os) = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() = 0;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">virtual</span> int64_t byteCount() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeNull() = 0;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeBool(<span class="keywordtype">bool</span> b) = 0;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeInt(int32_t i) = 0;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeLong(int64_t l) = 0;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeFloat(<span class="keywordtype">float</span> f) = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeDouble(<span class="keywordtype">double</span> d) = 0;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeString(<span class="keyword">const</span> std::string&amp; s) = 0;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeBytes(<span class="keyword">const</span> uint8_t *bytes, <span class="keywordtype">size_t</span> len) = 0;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classavro_1_1Encoder.html#add8c2db9736653e6d984962912d61e50"> 101</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classavro_1_1Encoder.html#add8c2db9736653e6d984962912d61e50">encodeBytes</a>(<span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; bytes) {</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; uint8_t b = 0;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; encodeBytes(bytes.empty() ? &amp;b : bytes.data(), bytes.size());</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeFixed(<span class="keyword">const</span> uint8_t *bytes, <span class="keywordtype">size_t</span> len) = 0;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classavro_1_1Encoder.html#a911b82ef2f18c70d8f30dab01eeb7f07"> 114</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classavro_1_1Encoder.html#a911b82ef2f18c70d8f30dab01eeb7f07">encodeFixed</a>(<span class="keyword">const</span> std::vector&lt;uint8_t&gt;&amp; bytes) {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; encodeFixed(bytes.data(), bytes.size());</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeEnum(<span class="keywordtype">size_t</span> e) = 0;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> arrayStart() = 0;</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> arrayEnd() = 0;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> mapStart() = 0;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> mapEnd() = 0;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> setItemCount(<span class="keywordtype">size_t</span> count) = 0;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> startItem() = 0;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> encodeUnionIndex(<span class="keywordtype">size_t</span> e) = 0;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;};</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="namespaceavro.html#a73d301acfedf564ff033eba5ec68aa86"> 147</a></span>&#160;<span class="keyword">typedef</span> std::shared_ptr&lt;Encoder&gt; <a class="code" href="namespaceavro.html#a73d301acfedf564ff033eba5ec68aa86">EncoderPtr</a>;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;AVRO_DECL EncoderPtr <a class="code" href="namespaceavro.html#ad0158bd2fc76615b68db68d7e4f7c4f6">binaryEncoder</a>();</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;AVRO_DECL EncoderPtr <a class="code" href="namespaceavro.html#a1ba750d980390623baeae24bc24b286e">validatingEncoder</a>(<span class="keyword">const</span> <a class="code" href="classavro_1_1ValidSchema.html">ValidSchema</a>&amp; schema,</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keyword">const</span> EncoderPtr&amp; base);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;AVRO_DECL EncoderPtr <a class="code" href="namespaceavro.html#a0847ef62f42f6f0d0af28da9f7c7cf15">jsonEncoder</a>(<span class="keyword">const</span> <a class="code" href="classavro_1_1ValidSchema.html">ValidSchema</a>&amp; schema);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;AVRO_DECL EncoderPtr <a class="code" href="namespaceavro.html#aaa6028342a629213643d27da4a0aba5d">jsonPrettyEncoder</a>(<span class="keyword">const</span> <a class="code" href="classavro_1_1ValidSchema.html">ValidSchema</a>&amp; schema);</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;} <span class="comment">// namespace avro</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceavro_html_aaa6028342a629213643d27da4a0aba5d"><div class="ttname"><a href="namespaceavro.html#aaa6028342a629213643d27da4a0aba5d">avro::jsonPrettyEncoder</a></div><div class="ttdeci">AVRO_DECL EncoderPtr jsonPrettyEncoder(const ValidSchema &amp;schema)</div><div class="ttdoc">Returns an encoder that encodes Avro standard for pretty printed JSON. </div></div>
<div class="ttc" id="classavro_1_1Encoder_html_a911b82ef2f18c70d8f30dab01eeb7f07"><div class="ttname"><a href="classavro_1_1Encoder.html#a911b82ef2f18c70d8f30dab01eeb7f07">avro::Encoder::encodeFixed</a></div><div class="ttdeci">void encodeFixed(const std::vector&lt; uint8_t &gt; &amp;bytes)</div><div class="ttdoc">Encodes an Avro data type Fixed. </div><div class="ttdef"><b>Definition:</b> Encoder.hh:114</div></div>
<div class="ttc" id="classavro_1_1Encoder_html_add8c2db9736653e6d984962912d61e50"><div class="ttname"><a href="classavro_1_1Encoder.html#add8c2db9736653e6d984962912d61e50">avro::Encoder::encodeBytes</a></div><div class="ttdeci">void encodeBytes(const std::vector&lt; uint8_t &gt; &amp;bytes)</div><div class="ttdoc">Encodes aribtray binary data into tthe current stream as Avro &quot;bytes&quot; data type. </div><div class="ttdef"><b>Definition:</b> Encoder.hh:101</div></div>
<div class="ttc" id="namespaceavro_html"><div class="ttname"><a href="namespaceavro.html">avro</a></div><div class="ttdoc">A bunch of templates and specializations for encoding and decoding specific types. </div><div class="ttdef"><b>Definition:</b> AvroParse.hh:30</div></div>
<div class="ttc" id="namespaceavro_html_a0847ef62f42f6f0d0af28da9f7c7cf15"><div class="ttname"><a href="namespaceavro.html#a0847ef62f42f6f0d0af28da9f7c7cf15">avro::jsonEncoder</a></div><div class="ttdeci">AVRO_DECL EncoderPtr jsonEncoder(const ValidSchema &amp;schema)</div><div class="ttdoc">Returns an encoder that encodes Avro standard for JSON. </div></div>
<div class="ttc" id="namespaceavro_html_a73d301acfedf564ff033eba5ec68aa86"><div class="ttname"><a href="namespaceavro.html#a73d301acfedf564ff033eba5ec68aa86">avro::EncoderPtr</a></div><div class="ttdeci">std::shared_ptr&lt; Encoder &gt; EncoderPtr</div><div class="ttdoc">Shared pointer to Encoder. </div><div class="ttdef"><b>Definition:</b> Encoder.hh:147</div></div>
<div class="ttc" id="classavro_1_1OutputStream_html"><div class="ttname"><a href="classavro_1_1OutputStream.html">avro::OutputStream</a></div><div class="ttdoc">A no-copy output stream. </div><div class="ttdef"><b>Definition:</b> Stream.hh:110</div></div>
<div class="ttc" id="classavro_1_1ValidSchema_html"><div class="ttname"><a href="classavro_1_1ValidSchema.html">avro::ValidSchema</a></div><div class="ttdoc">A ValidSchema is basically a non-mutable Schema that has passed some minumum of sanity checks...</div><div class="ttdef"><b>Definition:</b> ValidSchema.hh:40</div></div>
<div class="ttc" id="namespaceavro_html_a1ba750d980390623baeae24bc24b286e"><div class="ttname"><a href="namespaceavro.html#a1ba750d980390623baeae24bc24b286e">avro::validatingEncoder</a></div><div class="ttdeci">AVRO_DECL EncoderPtr validatingEncoder(const ValidSchema &amp;schema, const EncoderPtr &amp;base)</div><div class="ttdoc">Returns an encoder that validates sequence of calls to an underlying Encoder against the given schema...</div></div>
<div class="ttc" id="namespaceavro_html_ad0158bd2fc76615b68db68d7e4f7c4f6"><div class="ttname"><a href="namespaceavro.html#ad0158bd2fc76615b68db68d7e4f7c4f6">avro::binaryEncoder</a></div><div class="ttdeci">AVRO_DECL EncoderPtr binaryEncoder()</div><div class="ttdoc">Returns an encoder that can encode binary Avro standard. </div></div>
<div class="ttc" id="classavro_1_1Encoder_html"><div class="ttname"><a href="classavro_1_1Encoder.html">avro::Encoder</a></div><div class="ttdoc">The abstract base class for all Avro encoders. </div><div class="ttdef"><b>Definition:</b> Encoder.hh:52</div></div>
</div><!-- fragment --></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>