| <!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/file_metadata.h File Reference</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> |
| <!-- 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_5f8b885c726a45ce475267a26efacb77.html">puffin</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">file_metadata.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include <cstdint></code><br /> |
| <code>#include <optional></code><br /> |
| <code>#include <string></code><br /> |
| <code>#include <string_view></code><br /> |
| <code>#include <unordered_map></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include "iceberg/iceberg_data_export.h"</code><br /> |
| <code>#include "iceberg/result.h"</code><br /> |
| </div> |
| <p><a href="file__metadata_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1puffin_1_1StandardBlobTypes.html">iceberg::puffin::StandardBlobTypes</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Standard blob types defined by the Iceberg specification. <a href="structiceberg_1_1puffin_1_1StandardBlobTypes.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html">iceberg::puffin::StandardPuffinProperties</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Standard file-level properties for Puffin files. <a href="structiceberg_1_1puffin_1_1StandardPuffinProperties.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1puffin_1_1Blob.html">iceberg::puffin::Blob</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A blob in a Puffin file. <a href="structiceberg_1_1puffin_1_1Blob.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">iceberg::puffin::BlobMetadata</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Metadata about a blob stored in a Puffin file footer. <a href="structiceberg_1_1puffin_1_1BlobMetadata.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">iceberg::puffin::FileMetadata</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Metadata about a Puffin file. <a href="structiceberg_1_1puffin_1_1FileMetadata.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a370ebcb6e23ad5d7640b3f2a612b06cc" id="r_a370ebcb6e23ad5d7640b3f2a612b06cc"><td class="memItemLeft" align="right" valign="top"><a id="a370ebcb6e23ad5d7640b3f2a612b06cc" name="a370ebcb6e23ad5d7640b3f2a612b06cc"></a>enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">iceberg::puffin::PuffinCompressionCodec</a> { <b>kNone</b> |
| , <b>kLz4</b> |
| , <b>kZstd</b> |
| }</td></tr> |
| <tr class="memdesc:a370ebcb6e23ad5d7640b3f2a612b06cc"><td class="mdescLeft"> </td><td class="mdescRight">Compression codecs supported by Puffin files. <br /></td></tr> |
| <tr class="separator:a370ebcb6e23ad5d7640b3f2a612b06cc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:ad6e56d2c95523a28c547f15a0c132ff3" id="r_ad6e56d2c95523a28c547f15a0c132ff3"><td class="memItemLeft" align="right" valign="top"><a id="ad6e56d2c95523a28c547f15a0c132ff3" name="ad6e56d2c95523a28c547f15a0c132ff3"></a> |
| std::string_view </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::CodecName</b> (<a class="el" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> codec)</td></tr> |
| <tr class="separator:ad6e56d2c95523a28c547f15a0c132ff3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab1ec3e795b6cb1990eae3b53cc6bd793" id="r_ab1ec3e795b6cb1990eae3b53cc6bd793"><td class="memItemLeft" align="right" valign="top"><a id="ab1ec3e795b6cb1990eae3b53cc6bd793" name="ab1ec3e795b6cb1990eae3b53cc6bd793"></a> |
| Result< <a class="el" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::PuffinCompressionCodecFromName</b> (std::string_view codec_name)</td></tr> |
| <tr class="separator:ab1ec3e795b6cb1990eae3b53cc6bd793"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa59a86399aca0ff8f67d13c925e47815" id="r_aa59a86399aca0ff8f67d13c925e47815"><td class="memItemLeft" align="right" valign="top"><a id="aa59a86399aca0ff8f67d13c925e47815" name="aa59a86399aca0ff8f67d13c925e47815"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToString</b> (<a class="el" href="file__metadata_8h.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> codec)</td></tr> |
| <tr class="separator:aa59a86399aca0ff8f67d13c925e47815"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4b1d07a19160db7f26031b928cdbfd5" id="r_ad4b1d07a19160db7f26031b928cdbfd5"><td class="memItemLeft" align="right" valign="top"><a id="ad4b1d07a19160db7f26031b928cdbfd5" name="ad4b1d07a19160db7f26031b928cdbfd5"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToString</b> (const <a class="el" href="structiceberg_1_1puffin_1_1Blob.html">Blob</a> &blob)</td></tr> |
| <tr class="separator:ad4b1d07a19160db7f26031b928cdbfd5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae67ead257f7490f55dcd4d48b0b630e6" id="r_ae67ead257f7490f55dcd4d48b0b630e6"><td class="memItemLeft" align="right" valign="top"><a id="ae67ead257f7490f55dcd4d48b0b630e6" name="ae67ead257f7490f55dcd4d48b0b630e6"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToString</b> (const <a class="el" href="structiceberg_1_1puffin_1_1BlobMetadata.html">BlobMetadata</a> &blob_metadata)</td></tr> |
| <tr class="separator:ae67ead257f7490f55dcd4d48b0b630e6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a014b7ed48a8f2c1623fb3e85e5e49ada" id="r_a014b7ed48a8f2c1623fb3e85e5e49ada"><td class="memItemLeft" align="right" valign="top"><a id="a014b7ed48a8f2c1623fb3e85e5e49ada" name="a014b7ed48a8f2c1623fb3e85e5e49ada"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::ToString</b> (const <a class="el" href="structiceberg_1_1puffin_1_1FileMetadata.html">FileMetadata</a> &file_metadata)</td></tr> |
| <tr class="separator:a014b7ed48a8f2c1623fb3e85e5e49ada"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Data structures for Puffin files. </p> |
| </div></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> |
