blob: 2d842756b017c9a1eb19cdba9f3967373210a1a8 [file]
<!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::NameMapping 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_1NameMapping.html">NameMapping</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_1NameMapping-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::NameMapping Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a mapping from external schema names to Iceberg type IDs.
<a href="classiceberg_1_1NameMapping.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:ac8d379d9aac21acd99b3c970ea9a9ba5" id="r_ac8d379d9aac21acd99b3c970ea9a9ba5"><td class="memItemLeft" align="right" valign="top"><a id="ac8d379d9aac21acd99b3c970ea9a9ba5" name="ac8d379d9aac21acd99b3c970ea9a9ba5"></a>
std::optional&lt; MappedFieldConstRef &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Find</b> (int32_t id) const</td></tr>
<tr class="memdesc:ac8d379d9aac21acd99b3c970ea9a9ba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a field by its ID. <br /></td></tr>
<tr class="separator:ac8d379d9aac21acd99b3c970ea9a9ba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f6f0224ae291b16bd9690526e04195" id="r_a39f6f0224ae291b16bd9690526e04195"><td class="memItemLeft" align="right" valign="top"><a id="a39f6f0224ae291b16bd9690526e04195" name="a39f6f0224ae291b16bd9690526e04195"></a>
std::optional&lt; MappedFieldConstRef &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Find</b> (std::span&lt; const std::string &gt; names) const</td></tr>
<tr class="memdesc:a39f6f0224ae291b16bd9690526e04195"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a field by its unconcatenated names. <br /></td></tr>
<tr class="separator:a39f6f0224ae291b16bd9690526e04195"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad53b27c499f59307f566035cca179d91" id="r_ad53b27c499f59307f566035cca179d91"><td class="memItemLeft" align="right" valign="top"><a id="ad53b27c499f59307f566035cca179d91" name="ad53b27c499f59307f566035cca179d91"></a>
std::optional&lt; MappedFieldConstRef &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Find</b> (const std::string &amp;name) const</td></tr>
<tr class="memdesc:ad53b27c499f59307f566035cca179d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a field by its (concatenated) name. <br /></td></tr>
<tr class="separator:ad53b27c499f59307f566035cca179d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f36ae3f8c01f7fef9e740ffee9d836a" id="r_a2f36ae3f8c01f7fef9e740ffee9d836a"><td class="memItemLeft" align="right" valign="top"><a id="a2f36ae3f8c01f7fef9e740ffee9d836a" name="a2f36ae3f8c01f7fef9e740ffee9d836a"></a>
const <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>AsMappedFields</b> () const</td></tr>
<tr class="memdesc:a2f36ae3f8c01f7fef9e740ffee9d836a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the underlying <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:a2f36ae3f8c01f7fef9e740ffee9d836a"><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:a98c55a42873ca93287da04c9717b4070" id="r_a98c55a42873ca93287da04c9717b4070"><td class="memItemLeft" align="right" valign="top"><a id="a98c55a42873ca93287da04c9717b4070" name="a98c55a42873ca93287da04c9717b4070"></a>
static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (std::unique_ptr&lt; <a class="el" href="classiceberg_1_1MappedFields.html">MappedFields</a> &gt; fields)</td></tr>
<tr class="memdesc:a98c55a42873ca93287da04c9717b4070"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classiceberg_1_1NameMapping.html" title="Represents a mapping from external schema names to Iceberg type IDs.">NameMapping</a> instance. <br /></td></tr>
<tr class="separator:a98c55a42873ca93287da04c9717b4070"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a928fc8dcb964dabcaebb282ad20d9fd6" id="r_a928fc8dcb964dabcaebb282ad20d9fd6"><td class="memItemLeft" align="right" valign="top"><a id="a928fc8dcb964dabcaebb282ad20d9fd6" name="a928fc8dcb964dabcaebb282ad20d9fd6"></a>
static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Make</b> (std::vector&lt; <a class="el" href="structiceberg_1_1MappedField.html">MappedField</a> &gt; fields)</td></tr>
<tr class="memdesc:a928fc8dcb964dabcaebb282ad20d9fd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="classiceberg_1_1NameMapping.html" title="Represents a mapping from external schema names to Iceberg type IDs.">NameMapping</a> instance. <br /></td></tr>
<tr class="separator:a928fc8dcb964dabcaebb282ad20d9fd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a466e6ed544806f724485ca62dda7fc9e" id="r_a466e6ed544806f724485ca62dda7fc9e"><td class="memItemLeft" align="right" valign="top"><a id="a466e6ed544806f724485ca62dda7fc9e" name="a466e6ed544806f724485ca62dda7fc9e"></a>
static std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>MakeEmpty</b> ()</td></tr>
<tr class="memdesc:a466e6ed544806f724485ca62dda7fc9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty <a class="el" href="classiceberg_1_1NameMapping.html" title="Represents a mapping from external schema names to Iceberg type IDs.">NameMapping</a> instance. <br /></td></tr>
<tr class="separator:a466e6ed544806f724485ca62dda7fc9e"><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:a202ded6bd7fe8dbc27f752e480d3ede6" id="r_a202ded6bd7fe8dbc27f752e480d3ede6"><td class="memItemLeft" align="right" valign="top"><a id="a202ded6bd7fe8dbc27f752e480d3ede6" name="a202ded6bd7fe8dbc27f752e480d3ede6"></a>
ICEBERG_EXPORT friend bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &amp;lhs, const <a class="el" href="classiceberg_1_1NameMapping.html">NameMapping</a> &amp;rhs)</td></tr>
<tr class="separator:a202ded6bd7fe8dbc27f752e480d3ede6"><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>Represents a mapping from external schema names to Iceberg type IDs. </p>
</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>