blob: 0e4cc4b2510524a75d265bbb6607f1afbb9f4ea6 [file] [log] [blame]
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg/avro/avro_stream_internal.h 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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_81bb5441034a784c598ffcd7afd30d26.html">avro</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">avro_stream_internal.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" 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 id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" 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 id="l00006" 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 id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;arrow/io/interfaces.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;avro/Stream.hh&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">namespace </span>iceberg::avro {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="};">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="classiceberg_1_1avro_1_1AvroInputStream.html"> 27</a></span><span class="keyword">class </span><a class="code hl_class" href="classiceberg_1_1avro_1_1AvroInputStream.html">AvroInputStream</a> : <span class="keyword">public</span> ::avro::SeekableInputStream {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1avro_1_1AvroInputStream.html">AvroInputStream</a>(std::shared_ptr&lt;::arrow::io::RandomAccessFile&gt; input_stream,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> int64_t buffer_size);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="classiceberg_1_1avro_1_1AvroInputStream.html">~AvroInputStream</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroInputStream.html#a0752cc6936cbf003182448b41f2568b9">next</a>(<span class="keyword">const</span> uint8_t** data, <span class="keywordtype">size_t</span>* len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroInputStream.html#afecbdae55db643317487431eeb4a90a6">backup</a>(<span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroInputStream.html#af66622f1f78205470fbe7c7173e7ad03">skip</a>(<span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroInputStream.html#a3f81fa5ff908f87c10d5a2b2f981c7ba">byteCount</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroInputStream.html#abbccda243e4bcbc8cc508b9f32f88dfe">seek</a>(int64_t position) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> std::shared_ptr&lt;::arrow::io::RandomAccessFile&gt; input_stream_;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> int64_t buffer_size_;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::vector&lt;uint8_t&gt; buffer_;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">size_t</span> byte_count_ = 0; <span class="comment">// bytes read from the input stream</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">size_t</span> buffer_pos_ = 0; <span class="comment">// next position to read in the buffer</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">size_t</span> available_bytes_ = 0; <span class="comment">// bytes available in the buffer</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>};</div>
</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="};">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classiceberg_1_1avro_1_1AvroOutputStream.html"> 65</a></span><span class="keyword">class </span><a class="code hl_class" href="classiceberg_1_1avro_1_1AvroOutputStream.html">AvroOutputStream</a> : <span class="keyword">public</span> ::avro::OutputStream {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1avro_1_1AvroOutputStream.html">AvroOutputStream</a>(std::shared_ptr&lt;::arrow::io::OutputStream&gt; output_stream,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> int64_t buffer_size);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_class" href="classiceberg_1_1avro_1_1AvroOutputStream.html">~AvroOutputStream</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroOutputStream.html#a5c859a3a32354ff147f2ca800dba5b8c">next</a>(uint8_t** data, <span class="keywordtype">size_t</span>* len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroOutputStream.html#a7177ab03a7fc28efe6a4c9ceef529ea1">backup</a>(<span class="keywordtype">size_t</span> len) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> uint64_t <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroOutputStream.html#a1472ab3fdbb4e4dfa169739a06a4671f">byteCount</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1avro_1_1AvroOutputStream.html#ae32eb7849a11ea0de22f245ad44cd9c1">flush</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">const</span> std::shared_ptr&lt;::arrow::io::OutputStream&gt;&amp; arrow_output_stream() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> std::shared_ptr&lt;::arrow::io::OutputStream&gt; output_stream_;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">const</span> int64_t buffer_size_;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> std::vector&lt;uint8_t&gt; buffer_;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">size_t</span> buffer_pos_ = 0; <span class="comment">// position in the buffer</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> uint64_t flushed_bytes_ = 0; <span class="comment">// bytes flushed to the output stream</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>};</div>
</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>} <span class="comment">// namespace iceberg::avro</span></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html">iceberg::avro::AvroInputStream</a></div><div class="ttdef"><b>Definition</b> avro_stream_internal.h:27</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html_a0752cc6936cbf003182448b41f2568b9"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html#a0752cc6936cbf003182448b41f2568b9">iceberg::avro::AvroInputStream::next</a></div><div class="ttdeci">bool next(const uint8_t **data, size_t *len) override</div><div class="ttdoc">Returns some of available data.</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:38</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html_a3f81fa5ff908f87c10d5a2b2f981c7ba"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html#a3f81fa5ff908f87c10d5a2b2f981c7ba">iceberg::avro::AvroInputStream::byteCount</a></div><div class="ttdeci">size_t byteCount() const override</div><div class="ttdoc">Returns the number of bytes read from this stream so far. All the bytes made available through next a...</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:88</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html_abbccda243e4bcbc8cc508b9f32f88dfe"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html#abbccda243e4bcbc8cc508b9f32f88dfe">iceberg::avro::AvroInputStream::seek</a></div><div class="ttdeci">void seek(int64_t position) override</div><div class="ttdoc">Seek to a specific position in the stream. This may invalidate pointers returned from next()....</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:90</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html_af66622f1f78205470fbe7c7173e7ad03"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html#af66622f1f78205470fbe7c7173e7ad03">iceberg::avro::AvroInputStream::skip</a></div><div class="ttdeci">void skip(size_t len) override</div><div class="ttdoc">Skips number of bytes specified by len.</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:77</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroInputStream_html_afecbdae55db643317487431eeb4a90a6"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroInputStream.html#afecbdae55db643317487431eeb4a90a6">iceberg::avro::AvroInputStream::backup</a></div><div class="ttdeci">void backup(size_t len) override</div><div class="ttdoc">&quot;Returns&quot; back some of the data to the stream. The returned data must be less than what was obtained ...</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:68</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroOutputStream_html"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroOutputStream.html">iceberg::avro::AvroOutputStream</a></div><div class="ttdef"><b>Definition</b> avro_stream_internal.h:65</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroOutputStream_html_a1472ab3fdbb4e4dfa169739a06a4671f"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroOutputStream.html#a1472ab3fdbb4e4dfa169739a06a4671f">iceberg::avro::AvroOutputStream::byteCount</a></div><div class="ttdeci">uint64_t byteCount() const override</div><div class="ttdoc">Number of bytes written so far into this stream. The whole buffer returned by next() is assumed to be...</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:127</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroOutputStream_html_a5c859a3a32354ff147f2ca800dba5b8c"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroOutputStream.html#a5c859a3a32354ff147f2ca800dba5b8c">iceberg::avro::AvroOutputStream::next</a></div><div class="ttdeci">bool next(uint8_t **data, size_t *len) override</div><div class="ttdoc">Returns a buffer that can be written into. On successful return, data has the pointer to the buffer a...</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:108</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroOutputStream_html_a7177ab03a7fc28efe6a4c9ceef529ea1"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroOutputStream.html#a7177ab03a7fc28efe6a4c9ceef529ea1">iceberg::avro::AvroOutputStream::backup</a></div><div class="ttdeci">void backup(size_t len) override</div><div class="ttdoc">&quot;Returns&quot; back to the stream some of the buffer obtained from in the last call to next().</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:120</div></div>
<div class="ttc" id="aclassiceberg_1_1avro_1_1AvroOutputStream_html_ae32eb7849a11ea0de22f245ad44cd9c1"><div class="ttname"><a href="classiceberg_1_1avro_1_1AvroOutputStream.html#ae32eb7849a11ea0de22f245ad44cd9c1">iceberg::avro::AvroOutputStream::flush</a></div><div class="ttdeci">void flush() override</div><div class="ttdoc">Flushes any data remaining in the buffer to the stream's underlying store, if any.</div><div class="ttdef"><b>Definition</b> avro_stream_internal.cc:129</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>