| <!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/puffin/puffin_reader.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&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&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&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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_d29ce3c247234cc8bacd7c637d3a05c6.html">puffin</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">puffin_reader.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="puffin__reader_8h.html">Go to the documentation of this file.</a><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"> * "License"); 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"> * "AS IS" 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="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="preprocessor">#include <cstddef></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <utility></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include <vector></span></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><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="file__metadata_8h.html">iceberg/puffin/file_metadata.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1puffin.html">iceberg::puffin</a> {</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="foldopen" id="foldopen00042" data-start="{" data-end="};"> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html"> 42</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1puffin_1_1PuffinReader.html">PuffinReader</a> {</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html#a6f0cfb1ff8bd4ffbf8612889867b28ab"> 48</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<PuffinReader></a>> <a class="code hl_function" href="classiceberg_1_1puffin_1_1PuffinReader.html#a6f0cfb1ff8bd4ffbf8612889867b28ab">Make</a>(</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::unique_ptr<InputFile> input_file,</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> std::optional<int64_t> footer_size = std::nullopt,</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> std::optional<int64_t> file_size = std::nullopt);</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_class" href="classiceberg_1_1puffin_1_1PuffinReader.html">~PuffinReader</a>();</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html#a5354edf88915d4133def58b0f614b7e1"> 56</a></span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<FileMetadata></a> <a class="code hl_function" href="classiceberg_1_1puffin_1_1PuffinReader.html#a5354edf88915d4133def58b0f614b7e1">ReadFileMetadata</a>();</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html#a49cc2e691d2ecd7325277e289b2e8535"> 61</a></span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::pair<BlobMetadata, std::vector<std::byte></a>>> <a class="code hl_function" href="classiceberg_1_1puffin_1_1PuffinReader.html#a49cc2e691d2ecd7325277e289b2e8535">ReadBlob</a>(</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a>& blob_metadata);</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html#a30abba404e17cb36132006b1b87a47e9"> 66</a></span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::vector<std::pair<BlobMetadata, std::vector<std::byte></a>>>> <a class="code hl_function" href="classiceberg_1_1puffin_1_1PuffinReader.html#a30abba404e17cb36132006b1b87a47e9">ReadAll</a>(</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">const</span> std::vector<BlobMetadata>& blobs);</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1puffin_1_1PuffinReader.html#a622d9e85adccdaa3d5b35ab82696677c"> 70</a></span> Status <a class="code hl_function" href="classiceberg_1_1puffin_1_1PuffinReader.html#a622d9e85adccdaa3d5b35ab82696677c">Close</a>();</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_class" href="classiceberg_1_1puffin_1_1PuffinReader.html">PuffinReader</a>(std::unique_ptr<SeekableInputStream> stream, int64_t file_size,</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> std::optional<int64_t> known_footer_size);</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::vector<std::byte></a>> ReadBytes(int64_t offset, int64_t length);</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<int64_t></a> FooterSize();</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::vector<std::byte></a>> ReadFooter(int64_t footer_size);</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> std::unique_ptr<SeekableInputStream> stream_;</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> int64_t file_size_;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> std::optional<int64_t> known_footer_size_;</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">bool</span> closed_ = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>};</div> |
| </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="comment">// namespace iceberg::puffin</span></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html">iceberg::puffin::PuffinReader</a></div><div class="ttdoc">Reader for Puffin files.</div><div class="ttdef"><b>Definition</b> puffin_reader.h:42</div></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html_a30abba404e17cb36132006b1b87a47e9"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html#a30abba404e17cb36132006b1b87a47e9">iceberg::puffin::PuffinReader::ReadAll</a></div><div class="ttdeci">Result< std::vector< std::pair< BlobMetadata, std::vector< std::byte > > > > ReadAll(const std::vector< BlobMetadata > &blobs)</div><div class="ttdoc">Read all blobs described in the file metadata.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html_a49cc2e691d2ecd7325277e289b2e8535"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html#a49cc2e691d2ecd7325277e289b2e8535">iceberg::puffin::PuffinReader::ReadBlob</a></div><div class="ttdeci">Result< std::pair< BlobMetadata, std::vector< std::byte > > > ReadBlob(const BlobMetadata &blob_metadata)</div><div class="ttdoc">Read a specific blob's data by its metadata.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html_a5354edf88915d4133def58b0f614b7e1"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html#a5354edf88915d4133def58b0f614b7e1">iceberg::puffin::PuffinReader::ReadFileMetadata</a></div><div class="ttdeci">Result< FileMetadata > ReadFileMetadata()</div><div class="ttdoc">Read and return the file metadata from the footer.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html_a622d9e85adccdaa3d5b35ab82696677c"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html#a622d9e85adccdaa3d5b35ab82696677c">iceberg::puffin::PuffinReader::Close</a></div><div class="ttdeci">Status Close()</div><div class="ttdoc">Close the underlying input stream.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1puffin_1_1PuffinReader_html_a6f0cfb1ff8bd4ffbf8612889867b28ab"><div class="ttname"><a href="classiceberg_1_1puffin_1_1PuffinReader.html#a6f0cfb1ff8bd4ffbf8612889867b28ab">iceberg::puffin::PuffinReader::Make</a></div><div class="ttdeci">static Result< std::unique_ptr< PuffinReader > > Make(std::unique_ptr< InputFile > input_file, std::optional< int64_t > footer_size=std::nullopt, std::optional< int64_t > file_size=std::nullopt)</div><div class="ttdoc">Create a PuffinReader for the given input file.</div></div> |
| <div class="ttc" id="afile__metadata_8h_html"><div class="ttname"><a href="file__metadata_8h.html">file_metadata.h</a></div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1puffin_html"><div class="ttname"><a href="namespaceiceberg_1_1puffin.html">iceberg::puffin</a></div><div class="ttdoc">Puffin file metadata, reader, and writer APIs.</div><div class="ttdef"><b>Definition</b> file_metadata.h:35</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1puffin_1_1BlobMetadata_html"><div class="ttname"><a href="structiceberg_1_1puffin_1_1BlobMetadata.html">iceberg::puffin::BlobMetadata</a></div><div class="ttdoc">Metadata about a blob stored in a Puffin file footer.</div><div class="ttdef"><b>Definition</b> file_metadata.h:90</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
