| <?xml version='1.0' encoding='UTF-8' standalone='no'?> |
| <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.9.8" xml:lang="en-US"> |
| <compounddef id="puffin__reader_8h" kind="file" language="C++"> |
| <compoundname>puffin_reader.h</compoundname> |
| <includes local="no">cstddef</includes> |
| <includes local="no">cstdint</includes> |
| <includes local="no">memory</includes> |
| <includes local="no">optional</includes> |
| <includes local="no">utility</includes> |
| <includes local="no">vector</includes> |
| <includes refid="iceberg__export_8h" local="yes">iceberg/iceberg_export.h</includes> |
| <includes refid="file__metadata_8h" local="yes">iceberg/puffin/file_metadata.h</includes> |
| <includes refid="result_8h" local="yes">iceberg/result.h</includes> |
| <includes refid="type__fwd_8h" local="yes">iceberg/type_fwd.h</includes> |
| <incdepgraph> |
| <node id="8"> |
| <label>iceberg/iceberg_export.h</label> |
| <link refid="iceberg__export_8h"/> |
| </node> |
| <node id="9"> |
| <label>iceberg/puffin/file_metadata.h</label> |
| <link refid="file__metadata_8h"/> |
| <childnode refid="3" relation="include"> |
| </childnode> |
| <childnode refid="5" relation="include"> |
| </childnode> |
| <childnode refid="10" relation="include"> |
| </childnode> |
| <childnode refid="11" relation="include"> |
| </childnode> |
| <childnode refid="12" relation="include"> |
| </childnode> |
| <childnode refid="7" relation="include"> |
| </childnode> |
| <childnode refid="8" relation="include"> |
| </childnode> |
| <childnode refid="13" relation="include"> |
| </childnode> |
| </node> |
| <node id="1"> |
| <label>iceberg/puffin/puffin_reader.h</label> |
| <link refid="puffin__reader_8h"/> |
| <childnode refid="2" relation="include"> |
| </childnode> |
| <childnode refid="3" relation="include"> |
| </childnode> |
| <childnode refid="4" relation="include"> |
| </childnode> |
| <childnode refid="5" relation="include"> |
| </childnode> |
| <childnode refid="6" relation="include"> |
| </childnode> |
| <childnode refid="7" relation="include"> |
| </childnode> |
| <childnode refid="8" relation="include"> |
| </childnode> |
| <childnode refid="9" relation="include"> |
| </childnode> |
| <childnode refid="13" relation="include"> |
| </childnode> |
| <childnode refid="18" relation="include"> |
| </childnode> |
| </node> |
| <node id="13"> |
| <label>iceberg/result.h</label> |
| <link refid="result_8h"/> |
| <childnode refid="14" relation="include"> |
| </childnode> |
| <childnode refid="15" relation="include"> |
| </childnode> |
| <childnode refid="16" relation="include"> |
| </childnode> |
| <childnode refid="10" relation="include"> |
| </childnode> |
| <childnode refid="17" relation="include"> |
| </childnode> |
| <childnode refid="8" relation="include"> |
| </childnode> |
| </node> |
| <node id="18"> |
| <label>iceberg/type_fwd.h</label> |
| <link refid="type__fwd_8h"/> |
| </node> |
| <node id="14"> |
| <label>concepts</label> |
| </node> |
| <node id="2"> |
| <label>cstddef</label> |
| </node> |
| <node id="3"> |
| <label>cstdint</label> |
| </node> |
| <node id="15"> |
| <label>expected</label> |
| </node> |
| <node id="16"> |
| <label>format</label> |
| </node> |
| <node id="4"> |
| <label>memory</label> |
| </node> |
| <node id="5"> |
| <label>optional</label> |
| </node> |
| <node id="10"> |
| <label>string</label> |
| </node> |
| <node id="11"> |
| <label>string_view</label> |
| </node> |
| <node id="17"> |
| <label>type_traits</label> |
| </node> |
| <node id="12"> |
| <label>unordered_map</label> |
| </node> |
| <node id="6"> |
| <label>utility</label> |
| </node> |
| <node id="7"> |
| <label>vector</label> |
| </node> |
| </incdepgraph> |
| <innerclass refid="classiceberg_1_1puffin_1_1PuffinReader" prot="public">iceberg::puffin::PuffinReader</innerclass> |
| <innernamespace refid="namespaceiceberg">iceberg</innernamespace> |
| <innernamespace refid="namespaceiceberg_1_1puffin">iceberg::puffin</innernamespace> |
| <briefdescription> |
| </briefdescription> |
| <detaileddescription> |
| <para>Puffin file reader. </para> |
| </detaileddescription> |
| <programlisting> |
| <codeline lineno="1"><highlight class="comment">/*</highlight></codeline> |
| <codeline lineno="2"><highlight class="comment"><sp/>*<sp/>Licensed<sp/>to<sp/>the<sp/>Apache<sp/>Software<sp/>Foundation<sp/>(ASF)<sp/>under<sp/>one</highlight></codeline> |
| <codeline lineno="3"><highlight class="comment"><sp/>*<sp/>or<sp/>more<sp/>contributor<sp/>license<sp/>agreements.<sp/><sp/>See<sp/>the<sp/>NOTICE<sp/>file</highlight></codeline> |
| <codeline lineno="4"><highlight class="comment"><sp/>*<sp/>distributed<sp/>with<sp/>this<sp/>work<sp/>for<sp/>additional<sp/>information</highlight></codeline> |
| <codeline lineno="5"><highlight class="comment"><sp/>*<sp/>regarding<sp/>copyright<sp/>ownership.<sp/><sp/>The<sp/>ASF<sp/>licenses<sp/>this<sp/>file</highlight></codeline> |
| <codeline lineno="6"><highlight class="comment"><sp/>*<sp/>to<sp/>you<sp/>under<sp/>the<sp/>Apache<sp/>License,<sp/>Version<sp/>2.0<sp/>(the</highlight></codeline> |
| <codeline lineno="7"><highlight class="comment"><sp/>*<sp/>"License");<sp/>you<sp/>may<sp/>not<sp/>use<sp/>this<sp/>file<sp/>except<sp/>in<sp/>compliance</highlight></codeline> |
| <codeline lineno="8"><highlight class="comment"><sp/>*<sp/>with<sp/>the<sp/>License.<sp/><sp/>You<sp/>may<sp/>obtain<sp/>a<sp/>copy<sp/>of<sp/>the<sp/>License<sp/>at</highlight></codeline> |
| <codeline lineno="9"><highlight class="comment"><sp/>*</highlight></codeline> |
| <codeline lineno="10"><highlight class="comment"><sp/>*<sp/><sp/><sp/>http://www.apache.org/licenses/LICENSE-2.0</highlight></codeline> |
| <codeline lineno="11"><highlight class="comment"><sp/>*</highlight></codeline> |
| <codeline lineno="12"><highlight class="comment"><sp/>*<sp/>Unless<sp/>required<sp/>by<sp/>applicable<sp/>law<sp/>or<sp/>agreed<sp/>to<sp/>in<sp/>writing,</highlight></codeline> |
| <codeline lineno="13"><highlight class="comment"><sp/>*<sp/>software<sp/>distributed<sp/>under<sp/>the<sp/>License<sp/>is<sp/>distributed<sp/>on<sp/>an</highlight></codeline> |
| <codeline lineno="14"><highlight class="comment"><sp/>*<sp/>"AS<sp/>IS"<sp/>BASIS,<sp/>WITHOUT<sp/>WARRANTIES<sp/>OR<sp/>CONDITIONS<sp/>OF<sp/>ANY</highlight></codeline> |
| <codeline lineno="15"><highlight class="comment"><sp/>*<sp/>KIND,<sp/>either<sp/>express<sp/>or<sp/>implied.<sp/><sp/>See<sp/>the<sp/>License<sp/>for<sp/>the</highlight></codeline> |
| <codeline lineno="16"><highlight class="comment"><sp/>*<sp/>specific<sp/>language<sp/>governing<sp/>permissions<sp/>and<sp/>limitations</highlight></codeline> |
| <codeline lineno="17"><highlight class="comment"><sp/>*<sp/>under<sp/>the<sp/>License.</highlight></codeline> |
| <codeline lineno="18"><highlight class="comment"><sp/>*/</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="19"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="20"><highlight class="normal"></highlight><highlight class="preprocessor">#pragma<sp/>once</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="21"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="24"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="25"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><cstddef></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="26"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><cstdint></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="27"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><memory></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="28"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><optional></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="29"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><utility></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="30"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/><vector></highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="31"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="32"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="iceberg__export_8h" kindref="compound">iceberg/iceberg_export.h</ref>"</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="33"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="file__metadata_8h" kindref="compound">iceberg/puffin/file_metadata.h</ref>"</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="34"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="result_8h" kindref="compound">iceberg/result.h</ref>"</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="35"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>"<ref refid="type__fwd_8h" kindref="compound">iceberg/type_fwd.h</ref>"</highlight><highlight class="normal"></highlight></codeline> |
| <codeline lineno="36"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="37"><highlight class="normal"></highlight><highlight class="keyword">namespace<sp/></highlight><highlight class="normal"><ref refid="namespaceiceberg_1_1puffin" kindref="compound">iceberg::puffin</ref><sp/>{</highlight></codeline> |
| <codeline lineno="38"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="42" refid="classiceberg_1_1puffin_1_1PuffinReader" refkind="compound"><highlight class="keyword">class<sp/></highlight><highlight class="normal">ICEBERG_EXPORT<sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader" kindref="compound">PuffinReader</ref><sp/>{</highlight></codeline> |
| <codeline lineno="43"><highlight class="normal"><sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal">:</highlight></codeline> |
| <codeline lineno="48" refid="classiceberg_1_1puffin_1_1PuffinReader_1a6f0cfb1ff8bd4ffbf8612889867b28ab" refkind="member"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">static</highlight><highlight class="normal"><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<std::unique_ptr<PuffinReader></ref>><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader_1a6f0cfb1ff8bd4ffbf8612889867b28ab" kindref="member">Make</ref>(</highlight></codeline> |
| <codeline lineno="49"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>std::unique_ptr<InputFile><sp/>input_file,</highlight></codeline> |
| <codeline lineno="50"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>std::optional<int64_t><sp/>footer_size<sp/>=<sp/>std::nullopt,</highlight></codeline> |
| <codeline lineno="51"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/>std::optional<int64_t><sp/>file_size<sp/>=<sp/>std::nullopt);</highlight></codeline> |
| <codeline lineno="52"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="53"><highlight class="normal"><sp/><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader" kindref="compound">~PuffinReader</ref>();</highlight></codeline> |
| <codeline lineno="54"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="56" refid="classiceberg_1_1puffin_1_1PuffinReader_1a5354edf88915d4133def58b0f614b7e1" refkind="member"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<FileMetadata></ref><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader_1a5354edf88915d4133def58b0f614b7e1" kindref="member">ReadFileMetadata</ref>();</highlight></codeline> |
| <codeline lineno="57"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="61" refid="classiceberg_1_1puffin_1_1PuffinReader_1a49cc2e691d2ecd7325277e289b2e8535" refkind="member"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<std::pair<BlobMetadata, std::vector<std::byte></ref>>><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader_1a49cc2e691d2ecd7325277e289b2e8535" kindref="member">ReadBlob</ref>(</highlight></codeline> |
| <codeline lineno="62"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/><ref refid="structiceberg_1_1puffin_1_1BlobMetadata" kindref="compound">BlobMetadata</ref>&<sp/>blob_metadata);</highlight></codeline> |
| <codeline lineno="63"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="66" refid="classiceberg_1_1puffin_1_1PuffinReader_1a30abba404e17cb36132006b1b87a47e9" refkind="member"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<std::vector<std::pair<BlobMetadata, std::vector<std::byte></ref>>>><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader_1a30abba404e17cb36132006b1b87a47e9" kindref="member">ReadAll</ref>(</highlight></codeline> |
| <codeline lineno="67"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/>std::vector<BlobMetadata>&<sp/>blobs);</highlight></codeline> |
| <codeline lineno="68"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="70" refid="classiceberg_1_1puffin_1_1PuffinReader_1a622d9e85adccdaa3d5b35ab82696677c" refkind="member"><highlight class="normal"><sp/><sp/>Status<sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader_1a622d9e85adccdaa3d5b35ab82696677c" kindref="member">Close</ref>();</highlight></codeline> |
| <codeline lineno="71"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="72"><highlight class="normal"><sp/></highlight><highlight class="keyword">private</highlight><highlight class="normal">:</highlight></codeline> |
| <codeline lineno="73"><highlight class="normal"><sp/><sp/><ref refid="classiceberg_1_1puffin_1_1PuffinReader" kindref="compound">PuffinReader</ref>(std::unique_ptr<SeekableInputStream><sp/>stream,<sp/>int64_t<sp/>file_size,</highlight></codeline> |
| <codeline lineno="74"><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/><sp/>std::optional<int64_t><sp/>known_footer_size);</highlight></codeline> |
| <codeline lineno="75"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="76"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<std::vector<std::byte></ref>><sp/>ReadBytes(int64_t<sp/>offset,<sp/>int64_t<sp/>length);</highlight></codeline> |
| <codeline lineno="77"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<int64_t></ref><sp/>FooterSize();</highlight></codeline> |
| <codeline lineno="78"><highlight class="normal"><sp/><sp/><ref refid="namespaceiceberg_1a9d5594e371beb516b0120e07e69d3af6" kindref="member">Result<std::vector<std::byte></ref>><sp/>ReadFooter(int64_t<sp/>footer_size);</highlight></codeline> |
| <codeline lineno="79"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="81"><highlight class="normal"><sp/><sp/>std::unique_ptr<SeekableInputStream><sp/>stream_;</highlight></codeline> |
| <codeline lineno="83"><highlight class="normal"><sp/><sp/>int64_t<sp/>file_size_;</highlight></codeline> |
| <codeline lineno="85"><highlight class="normal"><sp/><sp/>std::optional<int64_t><sp/>known_footer_size_;</highlight></codeline> |
| <codeline lineno="87"><highlight class="normal"><sp/><sp/></highlight><highlight class="keywordtype">bool</highlight><highlight class="normal"><sp/>closed_<sp/>=<sp/></highlight><highlight class="keyword">false</highlight><highlight class="normal">;</highlight></codeline> |
| <codeline lineno="88"><highlight class="normal">};</highlight></codeline> |
| <codeline lineno="89"><highlight class="normal"></highlight></codeline> |
| <codeline lineno="90"><highlight class="normal">}<sp/><sp/></highlight><highlight class="comment">//<sp/>namespace<sp/>iceberg::puffin</highlight><highlight class="normal"></highlight></codeline> |
| </programlisting> |
| <location file="iceberg/puffin/puffin_reader.h"/> |
| </compounddef> |
| </doxygen> |
