| <!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::TableMetadataUtil::Codec Struct 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="structiceberg_1_1TableMetadataUtil.html">TableMetadataUtil</a></li><li class="navelem"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html">Codec</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="structiceberg_1_1TableMetadataUtil_1_1Codec-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::TableMetadataUtil::Codec Struct Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a4e3423ecb7872ed883db52f9ddd7dd63" id="r_a4e3423ecb7872ed883db52f9ddd7dd63"><td class="memItemLeft" align="right" valign="top">static Result< MetadataFileCodecType > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html#a4e3423ecb7872ed883db52f9ddd7dd63">FromString</a> (std::string_view name)</td></tr> |
| <tr class="memdesc:a4e3423ecb7872ed883db52f9ddd7dd63"><td class="mdescLeft"> </td><td class="mdescRight">Returns the MetadataFileCodecType corresponding to the given string. <br /></td></tr> |
| <tr class="separator:a4e3423ecb7872ed883db52f9ddd7dd63"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56b2486cea80f2d08f20d2c453174a42" id="r_a56b2486cea80f2d08f20d2c453174a42"><td class="memItemLeft" align="right" valign="top">static Result< MetadataFileCodecType > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html#a56b2486cea80f2d08f20d2c453174a42">FromFileName</a> (std::string_view file_name)</td></tr> |
| <tr class="memdesc:a56b2486cea80f2d08f20d2c453174a42"><td class="mdescLeft"> </td><td class="mdescRight">Get the codec type from the table metadata file name. <br /></td></tr> |
| <tr class="separator:a56b2486cea80f2d08f20d2c453174a42"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae6da382f1dc40d08bd2f6474713296be" id="r_ae6da382f1dc40d08bd2f6474713296be"><td class="memItemLeft" align="right" valign="top">static Result< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html#ae6da382f1dc40d08bd2f6474713296be">NameToFileExtension</a> (std::string_view codec)</td></tr> |
| <tr class="memdesc:ae6da382f1dc40d08bd2f6474713296be"><td class="mdescLeft"> </td><td class="mdescRight">Get the file extension from the codec type. <br /></td></tr> |
| <tr class="separator:ae6da382f1dc40d08bd2f6474713296be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab765f898ff5d032e3a05e2b3095ebc6b" id="r_ab765f898ff5d032e3a05e2b3095ebc6b"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html#ab765f898ff5d032e3a05e2b3095ebc6b">TypeToFileExtension</a> (MetadataFileCodecType codec)</td></tr> |
| <tr class="memdesc:ab765f898ff5d032e3a05e2b3095ebc6b"><td class="mdescLeft"> </td><td class="mdescRight">Get the file extension from the codec type. <br /></td></tr> |
| <tr class="separator:ab765f898ff5d032e3a05e2b3095ebc6b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:ae2db69622d5aeb1c86602700db8d6e60" id="r_ae2db69622d5aeb1c86602700db8d6e60"><td class="memItemLeft" align="right" valign="top"><a id="ae2db69622d5aeb1c86602700db8d6e60" name="ae2db69622d5aeb1c86602700db8d6e60"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kTableMetadataFileSuffix</b> = ".metadata.json"</td></tr> |
| <tr class="separator:ae2db69622d5aeb1c86602700db8d6e60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e00b3b22f742a26ec460fe3a661c566" id="r_a1e00b3b22f742a26ec460fe3a661c566"><td class="memItemLeft" align="right" valign="top">static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1TableMetadataUtil_1_1Codec.html#a1e00b3b22f742a26ec460fe3a661c566">kCompGzipTableMetadataFileSuffix</a></td></tr> |
| <tr class="separator:a1e00b3b22f742a26ec460fe3a661c566"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3cec2228802dbf6ab108da81387bd5e4" id="r_a3cec2228802dbf6ab108da81387bd5e4"><td class="memItemLeft" align="right" valign="top"><a id="a3cec2228802dbf6ab108da81387bd5e4" name="a3cec2228802dbf6ab108da81387bd5e4"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kGzipTableMetadataFileSuffix</b> = ".gz.metadata.json"</td></tr> |
| <tr class="separator:a3cec2228802dbf6ab108da81387bd5e4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a02bf707f0d586e6f67c9a8950264edd9" id="r_a02bf707f0d586e6f67c9a8950264edd9"><td class="memItemLeft" align="right" valign="top"><a id="a02bf707f0d586e6f67c9a8950264edd9" name="a02bf707f0d586e6f67c9a8950264edd9"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kGzipTableMetadataFileExtension</b> = ".gz"</td></tr> |
| <tr class="separator:a02bf707f0d586e6f67c9a8950264edd9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a488aed62beea177f31b9e03b7c274ab7" id="r_a488aed62beea177f31b9e03b7c274ab7"><td class="memItemLeft" align="right" valign="top"><a id="a488aed62beea177f31b9e03b7c274ab7" name="a488aed62beea177f31b9e03b7c274ab7"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kCodecTypeGzip</b> = "GZIP"</td></tr> |
| <tr class="separator:a488aed62beea177f31b9e03b7c274ab7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae68a8cf7f6a1c7b058dfa41144920b5f" id="r_ae68a8cf7f6a1c7b058dfa41144920b5f"><td class="memItemLeft" align="right" valign="top"><a id="ae68a8cf7f6a1c7b058dfa41144920b5f" name="ae68a8cf7f6a1c7b058dfa41144920b5f"></a> |
| static constexpr std::string_view </td><td class="memItemRight" valign="bottom"><b>kCodecTypeNone</b> = "NONE"</td></tr> |
| <tr class="separator:ae68a8cf7f6a1c7b058dfa41144920b5f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a56b2486cea80f2d08f20d2c453174a42" name="a56b2486cea80f2d08f20d2c453174a42"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a56b2486cea80f2d08f20d2c453174a42">◆ </a></span>FromFileName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< MetadataFileCodecType > iceberg::TableMetadataUtil::Codec::FromFileName </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>file_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the codec type from the table metadata file name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_name</td><td>The name of the table metadata file. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The codec type of the table metadata file. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a4e3423ecb7872ed883db52f9ddd7dd63" name="a4e3423ecb7872ed883db52f9ddd7dd63"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4e3423ecb7872ed883db52f9ddd7dd63">◆ </a></span>FromString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< MetadataFileCodecType > iceberg::TableMetadataUtil::Codec::FromString </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the MetadataFileCodecType corresponding to the given string. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The string to parse. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The MetadataFileCodecType corresponding to the given string. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae6da382f1dc40d08bd2f6474713296be" name="ae6da382f1dc40d08bd2f6474713296be"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae6da382f1dc40d08bd2f6474713296be">◆ </a></span>NameToFileExtension()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::string > iceberg::TableMetadataUtil::Codec::NameToFileExtension </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>codec</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the file extension from the codec type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">codec</td><td>The codec name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The file extension of the codec. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ab765f898ff5d032e3a05e2b3095ebc6b" name="ab765f898ff5d032e3a05e2b3095ebc6b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab765f898ff5d032e3a05e2b3095ebc6b">◆ </a></span>TypeToFileExtension()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string iceberg::TableMetadataUtil::Codec::TypeToFileExtension </td> |
| <td>(</td> |
| <td class="paramtype">MetadataFileCodecType </td> |
| <td class="paramname"><em>codec</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the file extension from the codec type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">codec</td><td>The codec type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The file extension of the codec. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a1e00b3b22f742a26ec460fe3a661c566" name="a1e00b3b22f742a26ec460fe3a661c566"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1e00b3b22f742a26ec460fe3a661c566">◆ </a></span>kCompGzipTableMetadataFileSuffix</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">constexpr std::string_view iceberg::TableMetadataUtil::Codec::kCompGzipTableMetadataFileSuffix</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <b>Initial value:</b><div class="fragment"><div class="line">=</div> |
| <div class="line"> <span class="stringliteral">".metadata.json.gz"</span></div> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="table__metadata_8h_source.html">table_metadata.h</a></li> |
| <li>iceberg/<b>table_metadata.cc</b></li> |
| </ul> |
| </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> |
