| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: api/Serializer.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.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</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">Serializer.hh</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <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> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <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> <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> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef avro_Serializer_hh__</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define avro_Serializer_hh__</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <array></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <boost/noncopyable.hpp></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "Config.hh"</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "Writer.hh"</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceavro.html">avro</a> {</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span><<span class="keyword">class</span> Writer></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classavro_1_1Serializer.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="classavro_1_1Serializer.html">Serializer</a> : <span class="keyword">private</span> boost::noncopyable {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classavro_1_1Serializer.html#ac1097c11f497d917c18db97db8df39ff"> 38</a></span>  <span class="keyword">explicit</span> <a class="code" href="classavro_1_1Serializer.html#ac1097c11f497d917c18db97db8df39ff">Serializer</a>() : writer_() {}</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classavro_1_1Serializer.html#aee676e8b80267876edd5e886c63efe83"> 41</a></span>  <span class="keyword">explicit</span> <a class="code" href="classavro_1_1Serializer.html#aee676e8b80267876edd5e886c63efe83">Serializer</a>(<span class="keyword">const</span> <a class="code" href="classavro_1_1ValidSchema.html">ValidSchema</a> &schema) : writer_(schema) {}</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> writeNull() {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  writer_.writeValue(<a class="code" href="structavro_1_1Null.html">Null</a>());</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> writeBool(<span class="keywordtype">bool</span> val) {</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> writeInt(int32_t val) {</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> writeLong(int64_t val) {</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> writeFloat(<span class="keywordtype">float</span> val) {</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> writeDouble(<span class="keywordtype">double</span> val) {</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> writeBytes(<span class="keyword">const</span> <span class="keywordtype">void</span> *val, <span class="keywordtype">size_t</span> size) {</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  writer_.writeBytes(val, size);</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">template</span><<span class="keywordtype">size_t</span> N></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> writeFixed(<span class="keyword">const</span> uint8_t (&val)[N]) {</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  writer_.writeFixed(val);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">template</span><<span class="keywordtype">size_t</span> N></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> writeFixed(<span class="keyword">const</span> std::array<uint8_t, N> &val) {</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  writer_.writeFixed(val);</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> writeString(<span class="keyword">const</span> std::string &val) {</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  writer_.writeValue(val);</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> writeRecord() {</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  writer_.writeRecord();</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> writeRecordEnd() {</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  writer_.writeRecordEnd();</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> writeArrayBlock(int64_t size) {</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  writer_.writeArrayBlock(size);</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> writeArrayEnd() {</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  writer_.writeArrayEnd();</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  </div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> writeMapBlock(int64_t size) {</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  writer_.writeMapBlock(size);</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">void</span> writeMapEnd() {</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  writer_.writeMapEnd();</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> writeUnion(int64_t choice) {</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  writer_.writeUnion(choice);</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> writeEnum(int64_t choice) {</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  writer_.writeEnum(choice);</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  InputBuffer buffer()<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">return</span> writer_.buffer();</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  }</div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  Writer writer_;</div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> };</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> } <span class="comment">// namespace avro</span></div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#endif</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <div class="ttc" id="aclassavro_1_1Serializer_html"><div class="ttname"><a href="classavro_1_1Serializer.html">avro::Serializer</a></div><div class="ttdoc">Class that wraps a Writer or ValidatingWriter with an interface that uses explicit write* names inste...</div><div class="ttdef"><b>Definition:</b> Serializer.hh:34</div></div> |
| <div class="ttc" id="aclassavro_1_1Serializer_html_ac1097c11f497d917c18db97db8df39ff"><div class="ttname"><a href="classavro_1_1Serializer.html#ac1097c11f497d917c18db97db8df39ff">avro::Serializer::Serializer</a></div><div class="ttdeci">Serializer()</div><div class="ttdoc">Constructor only works with Writer.</div><div class="ttdef"><b>Definition:</b> Serializer.hh:38</div></div> |
| <div class="ttc" id="anamespaceavro_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="aclassavro_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 minimum of sanity checks.</div><div class="ttdef"><b>Definition:</b> ValidSchema.hh:40</div></div> |
| <div class="ttc" id="astructavro_1_1Null_html"><div class="ttname"><a href="structavro_1_1Null.html">avro::Null</a></div><div class="ttdoc">define a type to represent Avro Null in template functions</div><div class="ttdef"><b>Definition:</b> Types.hh:101</div></div> |
| <div class="ttc" id="aclassavro_1_1Serializer_html_aee676e8b80267876edd5e886c63efe83"><div class="ttname"><a href="classavro_1_1Serializer.html#aee676e8b80267876edd5e886c63efe83">avro::Serializer::Serializer</a></div><div class="ttdeci">Serializer(const ValidSchema &schema)</div><div class="ttdoc">Constructor only works with ValidatingWriter.</div><div class="ttdef"><b>Definition:</b> Serializer.hh:41</div></div> |
| <!-- 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.17 |
| </small></address> |
| </body> |
| </html> |
