blob: 780d8d3ab96149b19b994b6f7ec938b219ba281d [file] [log] [blame]
<!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/file_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&amp;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&amp;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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">file_format.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;string_view&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;iceberg/iceberg_export.h&quot;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
<code>#include &quot;iceberg/util/string_util.h&quot;</code><br />
</div>
<p><a href="file__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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6c6a9823b4f3275c85997c3ab98211fd" id="r_a6c6a9823b4f3275c85997c3ab98211fd"><td class="memItemLeft" align="right" valign="top"><a id="a6c6a9823b4f3275c85997c3ab98211fd" name="a6c6a9823b4f3275c85997c3ab98211fd"></a>
ICEBERG_EXPORT std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::ToString</b> (FileFormatType format_type)</td></tr>
<tr class="memdesc:a6c6a9823b4f3275c85997c3ab98211fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a FileFormatType to a string. <br /></td></tr>
<tr class="separator:a6c6a9823b4f3275c85997c3ab98211fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac636c6e570a5e0902e16087c7322c6a7" id="r_ac636c6e570a5e0902e16087c7322c6a7"><td class="memItemLeft" align="right" valign="top"><a id="ac636c6e570a5e0902e16087c7322c6a7" name="ac636c6e570a5e0902e16087c7322c6a7"></a>
ICEBERG_EXPORT Result&lt; FileFormatType &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::FileFormatTypeFromString</b> (std::string_view str) noexcept</td></tr>
<tr class="memdesc:ac636c6e570a5e0902e16087c7322c6a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a string to a FileFormatType. <br /></td></tr>
<tr class="separator:ac636c6e570a5e0902e16087c7322c6a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a894c229e52ede0f8a5654e019e650315" id="r_a894c229e52ede0f8a5654e019e650315"><td class="memItemLeft" align="right" valign="top"><a id="a894c229e52ede0f8a5654e019e650315" name="a894c229e52ede0f8a5654e019e650315"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>kParquet</b></td></tr>
<tr class="separator:a894c229e52ede0f8a5654e019e650315"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac21a87df05694a8fe34837fe217d74e2" id="r_ac21a87df05694a8fe34837fe217d74e2"><td class="memItemLeft" align="right" valign="top"><a id="ac21a87df05694a8fe34837fe217d74e2" name="ac21a87df05694a8fe34837fe217d74e2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>kAvro</b></td></tr>
<tr class="separator:ac21a87df05694a8fe34837fe217d74e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2aa1de7654c215f7581b228e51df311" id="r_ae2aa1de7654c215f7581b228e51df311"><td class="memItemLeft" align="right" valign="top"><a id="ae2aa1de7654c215f7581b228e51df311" name="ae2aa1de7654c215f7581b228e51df311"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>kOrc</b></td></tr>
<tr class="separator:ae2aa1de7654c215f7581b228e51df311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcb48f2f8c7abd8d5d5322c328ad396e" id="r_adcb48f2f8c7abd8d5d5322c328ad396e"><td class="memItemLeft" align="right" valign="top"><a id="adcb48f2f8c7abd8d5d5322c328ad396e" name="adcb48f2f8c7abd8d5d5322c328ad396e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>kPuffin</b></td></tr>
<tr class="separator:adcb48f2f8c7abd8d5d5322c328ad396e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File format used by Iceberg. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>