| <!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_format.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_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="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">puffin_format.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include <array></code><br /> |
| <code>#include <cstddef></code><br /> |
| <code>#include <cstdint></code><br /> |
| <code>#include <span></code><br /> |
| <code>#include <vector></code><br /> |
| <code>#include "<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>"</code><br /> |
| <code>#include "<a class="el" href="file__metadata_8h_source.html">iceberg/puffin/file_metadata.h</a>"</code><br /> |
| <code>#include "<a class="el" href="result_8h_source.html">iceberg/result.h</a>"</code><br /> |
| </div> |
| <p><a href="puffin__format_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_1PuffinFormat.html">iceberg::puffin::PuffinFormat</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Puffin file format constants. <a href="structiceberg_1_1puffin_1_1PuffinFormat.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="namespaces" name="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr> |
| <tr class="memdesc:namespaceiceberg"><td class="mdescLeft"> </td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:namespaceiceberg_1_1puffin" id="r_namespaceiceberg_1_1puffin"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1puffin.html">iceberg::puffin</a></td></tr> |
| <tr class="memdesc:namespaceiceberg_1_1puffin"><td class="mdescLeft"> </td><td class="mdescRight">Puffin file metadata, reader, and writer APIs. <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:a2cd3ff021208ed4bccdf50de53744870" id="r_a2cd3ff021208ed4bccdf50de53744870"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1puffin.html#a2cd3ff021208ed4bccdf50de53744870">iceberg::puffin::PuffinFlag</a> : uint8_t { <a class="el" href="namespaceiceberg_1_1puffin.html#a2cd3ff021208ed4bccdf50de53744870a6919a327c0dd61cf2818006d9ceb022f">iceberg::puffin::kFooterPayloadCompressed</a> = 0 |
| }</td></tr> |
| <tr class="memdesc:a2cd3ff021208ed4bccdf50de53744870"><td class="mdescLeft"> </td><td class="mdescRight">Footer flags for Puffin files. <a href="namespaceiceberg_1_1puffin.html#a2cd3ff021208ed4bccdf50de53744870">More...</a><br /></td></tr> |
| <tr class="separator:a2cd3ff021208ed4bccdf50de53744870"><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:a6969193b57fe4b4d9e020c34f88d4446" id="r_a6969193b57fe4b4d9e020c34f88d4446"><td class="memItemLeft" align="right" valign="top"><a id="a6969193b57fe4b4d9e020c34f88d4446" name="a6969193b57fe4b4d9e020c34f88d4446"></a> |
| ICEBERG_EXPORT bool </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::IsFlagSet</b> (std::span< const uint8_t, 4 > flags, <a class="el" href="namespaceiceberg_1_1puffin.html#a2cd3ff021208ed4bccdf50de53744870">PuffinFlag</a> flag)</td></tr> |
| <tr class="memdesc:a6969193b57fe4b4d9e020c34f88d4446"><td class="mdescLeft"> </td><td class="mdescRight">Check if a flag is set in the flags bytes. <br /></td></tr> |
| <tr class="separator:a6969193b57fe4b4d9e020c34f88d4446"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78c0b1d90052e976acbe083732e6f591" id="r_a78c0b1d90052e976acbe083732e6f591"><td class="memItemLeft" align="right" valign="top"><a id="a78c0b1d90052e976acbe083732e6f591" name="a78c0b1d90052e976acbe083732e6f591"></a> |
| ICEBERG_EXPORT void </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::SetFlag</b> (std::span< uint8_t, 4 > flags, <a class="el" href="namespaceiceberg_1_1puffin.html#a2cd3ff021208ed4bccdf50de53744870">PuffinFlag</a> flag)</td></tr> |
| <tr class="memdesc:a78c0b1d90052e976acbe083732e6f591"><td class="mdescLeft"> </td><td class="mdescRight">Set a flag in the flags bytes. <br /></td></tr> |
| <tr class="separator:a78c0b1d90052e976acbe083732e6f591"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac13c4c47a7697a74c5da772ea1afb3b7" id="r_ac13c4c47a7697a74c5da772ea1afb3b7"><td class="memItemLeft" align="right" valign="top"><a id="ac13c4c47a7697a74c5da772ea1afb3b7" name="ac13c4c47a7697a74c5da772ea1afb3b7"></a> |
| ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::vector< std::byte > > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::Compress</b> (<a class="el" href="namespaceiceberg_1_1puffin.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> codec, std::span< const std::byte > input)</td></tr> |
| <tr class="memdesc:ac13c4c47a7697a74c5da772ea1afb3b7"><td class="mdescLeft"> </td><td class="mdescRight">Compress data using the specified codec. <br /></td></tr> |
| <tr class="separator:ac13c4c47a7697a74c5da772ea1afb3b7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a498f935320fd9cf47395ee7e0bbf49bb" id="r_a498f935320fd9cf47395ee7e0bbf49bb"><td class="memItemLeft" align="right" valign="top"><a id="a498f935320fd9cf47395ee7e0bbf49bb" name="a498f935320fd9cf47395ee7e0bbf49bb"></a> |
| ICEBERG_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::vector< std::byte > > </td><td class="memItemRight" valign="bottom"><b>iceberg::puffin::Decompress</b> (<a class="el" href="namespaceiceberg_1_1puffin.html#a370ebcb6e23ad5d7640b3f2a612b06cc">PuffinCompressionCodec</a> codec, std::span< const std::byte > input)</td></tr> |
| <tr class="memdesc:a498f935320fd9cf47395ee7e0bbf49bb"><td class="mdescLeft"> </td><td class="mdescRight">Decompress data using the specified codec. <br /></td></tr> |
| <tr class="separator:a498f935320fd9cf47395ee7e0bbf49bb"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Puffin file format constants and utilities. </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> |
