Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1MappedFields.html
blob: 7061b8b9700ae3bd3a36a57b011ea5e07635a200 [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::MappedFields Class 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classiceberg_1_1MappedFields-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::MappedFields Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A list of field mappings for child field of structs, maps, and lists.
<a href="classiceberg_1_1MappedFields.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="name__mapping_8h_source.html">name_mapping.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2d20ffc4e6c84f05a24153e04ed6b079" id="r_a2d20ffc4e6c84f05a24153e04ed6b079"><td class="memItemLeft" align="right" valign="top">std::optional&lt; MappedFieldConstRef &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MappedFields.html#a2d20ffc4e6c84f05a24153e04ed6b079">Field</a> (int32_t id) const</td></tr>
<tr class="memdesc:a2d20ffc4e6c84f05a24153e04ed6b079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the field for a given field ID. <br /></td></tr>
<tr class="separator:a2d20ffc4e6c84f05a24153e04ed6b079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fc3ac3b250256e0ffc45e94e66ed074" id="r_a8fc3ac3b250256e0ffc45e94e66ed074"><td class="memItemLeft" align="right" valign="top">std::optional&lt; int32_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MappedFields.html#a8fc3ac3b250256e0ffc45e94e66ed074">Id</a> (std::string_view name) const</td></tr>
<tr class="memdesc:a8fc3ac3b250256e0ffc45e94e66ed074"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the field ID for a given field name. <br /></td></tr>
<tr class="separator:a8fc3ac3b250256e0ffc45e94e66ed074"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad491216bc71dbbc666dfb411cbb7e752" id="r_ad491216bc71dbbc666dfb411cbb7e752"><td class="memItemLeft" align="right" valign="top"><a id="ad491216bc71dbbc666dfb411cbb7e752" name="ad491216bc71dbbc666dfb411cbb7e752"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>Size</b> () const</td></tr>
<tr class="memdesc:ad491216bc71dbbc666dfb411cbb7e752"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of field mappings. <br /></td></tr>
<tr class="separator:ad491216bc71dbbc666dfb411cbb7e752"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97597831db305af19823f7ce81dc87ed" id="r_a97597831db305af19823f7ce81dc87ed"><td class="memItemLeft" align="right" valign="top"><a id="a97597831db305af19823f7ce81dc87ed" name="a97597831db305af19823f7ce81dc87ed"></a>
std::span&lt; const <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>fields</b> () const</td></tr>
<tr class="memdesc:a97597831db305af19823f7ce81dc87ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the list of field mappings. <br /></td></tr>
<tr class="separator:a97597831db305af19823f7ce81dc87ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a4d9a94184226b1bfdddb09e4f2926cec" id="r_a4d9a94184226b1bfdddb09e4f2926cec"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1MappedFields.html#a4d9a94184226b1bfdddb09e4f2926cec">Make</a> (std::vector&lt; <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &gt; <a class="el" href="classiceberg_1_1MappedFields.html#a97597831db305af19823f7ce81dc87ed">fields</a>)</td></tr>
<tr class="memdesc:a4d9a94184226b1bfdddb09e4f2926cec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classiceberg_1_1MappedFields.html" title="A list of field mappings for child field of structs, maps, and lists.">MappedFields</a> instance. <br /></td></tr>
<tr class="separator:a4d9a94184226b1bfdddb09e4f2926cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a690ec76244b4628ec79aa9c256dce8f2" id="r_a690ec76244b4628ec79aa9c256dce8f2"><td class="memItemLeft" align="right" valign="top"><a id="a690ec76244b4628ec79aa9c256dce8f2" name="a690ec76244b4628ec79aa9c256dce8f2"></a>
ICEBERG_EXPORT friend bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &amp;lhs, const <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &amp;rhs)</td></tr>
<tr class="separator:a690ec76244b4628ec79aa9c256dce8f2"><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>A list of field mappings for child field of structs, maps, and lists. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d20ffc4e6c84f05a24153e04ed6b079" name="a2d20ffc4e6c84f05a24153e04ed6b079"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d20ffc4e6c84f05a24153e04ed6b079">&#9670;&#160;</a></span>Field()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt; MappedFieldConstRef &gt; iceberg::MappedFields::Field </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the field for a given field ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>The ID of the field. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The field for the given field ID. </dd></dl>
</div>
</div>
<a id="a8fc3ac3b250256e0ffc45e94e66ed074" name="a8fc3ac3b250256e0ffc45e94e66ed074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc3ac3b250256e0ffc45e94e66ed074">&#9670;&#160;</a></span>Id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt; int32_t &gt; iceberg::MappedFields::Id </td>
<td>(</td>
<td class="paramtype">std::string_view&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the field ID for a given field name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the field. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The field ID of the field. </dd></dl>
</div>
</div>
<a id="a4d9a94184226b1bfdddb09e4f2926cec" name="a4d9a94184226b1bfdddb09e4f2926cec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d9a94184226b1bfdddb09e4f2926cec">&#9670;&#160;</a></span>Make()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &gt; iceberg::MappedFields::Make </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &gt;&#160;</td>
<td class="paramname"><em>fields</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>Create a new <a class="el" href="classiceberg_1_1MappedFields.html" title="A list of field mappings for child field of structs, maps, and lists.">MappedFields</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>The list of field mappings. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classiceberg_1_1MappedFields.html" title="A list of field mappings for child field of structs, maps, and lists.">MappedFields</a> instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="name__mapping_8h_source.html">name_mapping.h</a></li>
<li>iceberg/<b>name_mapping.cc</b></li>
</ul>
</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>