Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/site/api/classiceberg_1_1DeleteFileSet.html
blob: d4081dbf2e2c2e2e9a339466ca1f3f1ed6046dab [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::DeleteFileSet 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1DeleteFileSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::DeleteFileSet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A set of delete-file pointers deduplicated by delete-file identity.
<a href="classiceberg_1_1DeleteFileSet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data__file__set_8h_source.html">data_file_set.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0568c52925f13b389c53c9edd55d4e4d" id="r_a0568c52925f13b389c53c9edd55d4e4d"><td class="memItemLeft" align="right" valign="top"><a id="a0568c52925f13b389c53c9edd55d4e4d" name="a0568c52925f13b389c53c9edd55d4e4d"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>value_type</b> = std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt;</td></tr>
<tr class="separator:a0568c52925f13b389c53c9edd55d4e4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a6bffed860ffaa704a6be9e15992c51" id="r_a2a6bffed860ffaa704a6be9e15992c51"><td class="memItemLeft" align="right" valign="top"><a id="a2a6bffed860ffaa704a6be9e15992c51" name="a2a6bffed860ffaa704a6be9e15992c51"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iterator</b> = typename std::vector&lt; value_type &gt;::iterator</td></tr>
<tr class="separator:a2a6bffed860ffaa704a6be9e15992c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b22213304a136cc5aa93f352c27d538" id="r_a0b22213304a136cc5aa93f352c27d538"><td class="memItemLeft" align="right" valign="top"><a id="a0b22213304a136cc5aa93f352c27d538" name="a0b22213304a136cc5aa93f352c27d538"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b> = typename std::vector&lt; value_type &gt;::const_iterator</td></tr>
<tr class="separator:a0b22213304a136cc5aa93f352c27d538"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae606a9fa0e1024afdf2030475c1825e7" id="r_ae606a9fa0e1024afdf2030475c1825e7"><td class="memItemLeft" align="right" valign="top"><a id="ae606a9fa0e1024afdf2030475c1825e7" name="ae606a9fa0e1024afdf2030475c1825e7"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>difference_type</b> = typename std::vector&lt; value_type &gt;::difference_type</td></tr>
<tr class="separator:ae606a9fa0e1024afdf2030475c1825e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a295be5df19c6c53cdab491ea80a43f4b" id="r_a295be5df19c6c53cdab491ea80a43f4b"><td class="memItemLeft" align="right" valign="top"><a id="a295be5df19c6c53cdab491ea80a43f4b" name="a295be5df19c6c53cdab491ea80a43f4b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeleteFileSet</b> (const <a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;other)</td></tr>
<tr class="separator:a295be5df19c6c53cdab491ea80a43f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e5e50caed505c7598577e679b4d3d03" id="r_a9e5e50caed505c7598577e679b4d3d03"><td class="memItemLeft" align="right" valign="top"><a id="a9e5e50caed505c7598577e679b4d3d03" name="a9e5e50caed505c7598577e679b4d3d03"></a>
<a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;other)</td></tr>
<tr class="separator:a9e5e50caed505c7598577e679b4d3d03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71fe51636320e8c85d96aa5edadfc0e2" id="r_a71fe51636320e8c85d96aa5edadfc0e2"><td class="memItemLeft" align="right" valign="top"><a id="a71fe51636320e8c85d96aa5edadfc0e2" name="a71fe51636320e8c85d96aa5edadfc0e2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DeleteFileSet</b> (<a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a71fe51636320e8c85d96aa5edadfc0e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ea494a7fadfadfa3a4ab46b34a85771" id="r_a4ea494a7fadfadfa3a4ab46b34a85771"><td class="memItemLeft" align="right" valign="top"><a id="a4ea494a7fadfadfa3a4ab46b34a85771" name="a4ea494a7fadfadfa3a4ab46b34a85771"></a>
<a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1DeleteFileSet.html">DeleteFileSet</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a4ea494a7fadfadfa3a4ab46b34a85771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a599375be334003015fb451be84653b82" id="r_a599375be334003015fb451be84653b82"><td class="memItemLeft" align="right" valign="top">std::pair&lt; iterator, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DeleteFileSet.html#a599375be334003015fb451be84653b82">insert</a> (const value_type &amp;file)</td></tr>
<tr class="memdesc:a599375be334003015fb451be84653b82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a delete file into the set. <br /></td></tr>
<tr class="separator:a599375be334003015fb451be84653b82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a4fc301f6b97e1e1325a283c55e5fc6" id="r_a6a4fc301f6b97e1e1325a283c55e5fc6"><td class="memItemLeft" align="right" valign="top"><a id="a6a4fc301f6b97e1e1325a283c55e5fc6" name="a6a4fc301f6b97e1e1325a283c55e5fc6"></a>
std::pair&lt; iterator, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>insert</b> (value_type &amp;&amp;file)</td></tr>
<tr class="memdesc:a6a4fc301f6b97e1e1325a283c55e5fc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a delete file into the set (move version). <br /></td></tr>
<tr class="separator:a6a4fc301f6b97e1e1325a283c55e5fc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12ef0c2728148ef2106b9eb5a89773f9" id="r_a12ef0c2728148ef2106b9eb5a89773f9"><td class="memItemLeft" align="right" valign="top"><a id="a12ef0c2728148ef2106b9eb5a89773f9" name="a12ef0c2728148ef2106b9eb5a89773f9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>contains</b> (const <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &amp;file) const</td></tr>
<tr class="memdesc:a12ef0c2728148ef2106b9eb5a89773f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether an equivalent delete file exists in the set. <br /></td></tr>
<tr class="separator:a12ef0c2728148ef2106b9eb5a89773f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e708d8da7ece8dcc759c1e889c14ded" id="r_a3e708d8da7ece8dcc759c1e889c14ded"><td class="memItemLeft" align="right" valign="top"><a id="a3e708d8da7ece8dcc759c1e889c14ded" name="a3e708d8da7ece8dcc759c1e889c14ded"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>contains</b> (const value_type &amp;file) const</td></tr>
<tr class="memdesc:a3e708d8da7ece8dcc759c1e889c14ded"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether an equivalent delete file exists in the set. <br /></td></tr>
<tr class="separator:a3e708d8da7ece8dcc759c1e889c14ded"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b4c866286b8ed33f8c1bb68ac6a9d1" id="r_ae9b4c866286b8ed33f8c1bb68ac6a9d1"><td class="memItemLeft" align="right" valign="top"><a id="ae9b4c866286b8ed33f8c1bb68ac6a9d1" name="ae9b4c866286b8ed33f8c1bb68ac6a9d1"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="memdesc:ae9b4c866286b8ed33f8c1bb68ac6a9d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of elements in the set. <br /></td></tr>
<tr class="separator:ae9b4c866286b8ed33f8c1bb68ac6a9d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0277408394b2ee6a4b9d2ede1744e2c" id="r_ad0277408394b2ee6a4b9d2ede1744e2c"><td class="memItemLeft" align="right" valign="top"><a id="ad0277408394b2ee6a4b9d2ede1744e2c" name="ad0277408394b2ee6a4b9d2ede1744e2c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="memdesc:ad0277408394b2ee6a4b9d2ede1744e2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the set is empty. <br /></td></tr>
<tr class="separator:ad0277408394b2ee6a4b9d2ede1744e2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae60211a89ac8deabc72876b415f5ea91" id="r_ae60211a89ac8deabc72876b415f5ea91"><td class="memItemLeft" align="right" valign="top"><a id="ae60211a89ac8deabc72876b415f5ea91" name="ae60211a89ac8deabc72876b415f5ea91"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr>
<tr class="memdesc:ae60211a89ac8deabc72876b415f5ea91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all elements from the set. <br /></td></tr>
<tr class="separator:ae60211a89ac8deabc72876b415f5ea91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e40a5aaeeeeea2348bd153a65aba458" id="r_a6e40a5aaeeeeea2348bd153a65aba458"><td class="memItemLeft" align="right" valign="top"><a id="a6e40a5aaeeeeea2348bd153a65aba458" name="a6e40a5aaeeeeea2348bd153a65aba458"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="memdesc:a6e40a5aaeeeeea2348bd153a65aba458"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the beginning. <br /></td></tr>
<tr class="separator:a6e40a5aaeeeeea2348bd153a65aba458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8db6905e25455489aee8eff590203e" id="r_a9b8db6905e25455489aee8eff590203e"><td class="memItemLeft" align="right" valign="top"><a id="a9b8db6905e25455489aee8eff590203e" name="a9b8db6905e25455489aee8eff590203e"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="separator:a9b8db6905e25455489aee8eff590203e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a229b782e233a46efdb6fac42ac872fb6" id="r_a229b782e233a46efdb6fac42ac872fb6"><td class="memItemLeft" align="right" valign="top"><a id="a229b782e233a46efdb6fac42ac872fb6" name="a229b782e233a46efdb6fac42ac872fb6"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cbegin</b> () const</td></tr>
<tr class="separator:a229b782e233a46efdb6fac42ac872fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8955f2480aa869ca5c04b724fb92af0" id="r_ad8955f2480aa869ca5c04b724fb92af0"><td class="memItemLeft" align="right" valign="top"><a id="ad8955f2480aa869ca5c04b724fb92af0" name="ad8955f2480aa869ca5c04b724fb92af0"></a>
iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr class="memdesc:ad8955f2480aa869ca5c04b724fb92af0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get iterator to the end. <br /></td></tr>
<tr class="separator:ad8955f2480aa869ca5c04b724fb92af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27b6301c8433b7e991492b2c7543637a" id="r_a27b6301c8433b7e991492b2c7543637a"><td class="memItemLeft" align="right" valign="top"><a id="a27b6301c8433b7e991492b2c7543637a" name="a27b6301c8433b7e991492b2c7543637a"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="separator:a27b6301c8433b7e991492b2c7543637a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb050f17189739168d8647283c1bb58a" id="r_adb050f17189739168d8647283c1bb58a"><td class="memItemLeft" align="right" valign="top"><a id="adb050f17189739168d8647283c1bb58a" name="adb050f17189739168d8647283c1bb58a"></a>
const_iterator&#160;</td><td class="memItemRight" valign="bottom"><b>cend</b> () const</td></tr>
<tr class="separator:adb050f17189739168d8647283c1bb58a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657ba84b6e391ed375dac46cb7a473b8" id="r_a657ba84b6e391ed375dac46cb7a473b8"><td class="memItemLeft" align="right" valign="top"><a id="a657ba84b6e391ed375dac46cb7a473b8" name="a657ba84b6e391ed375dac46cb7a473b8"></a>
std::span&lt; const value_type &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>as_span</b> () const</td></tr>
<tr class="memdesc:a657ba84b6e391ed375dac46cb7a473b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a non-owning view of the delete files in insertion order. <br /></td></tr>
<tr class="separator:a657ba84b6e391ed375dac46cb7a473b8"><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 set of delete-file pointers deduplicated by delete-file identity. </p>
<p>Delete files, especially deletion vectors, are identified by location plus content offset and content size. This mirrors Java's <a class="el" href="classiceberg_1_1DeleteFileSet.html" title="A set of delete-file pointers deduplicated by delete-file identity.">DeleteFileSet</a> behavior. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a599375be334003015fb451be84653b82" name="a599375be334003015fb451be84653b82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a599375be334003015fb451be84653b82">&#9670;&#160;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::pair&lt; iterator, bool &gt; iceberg::DeleteFileSet::insert </td>
<td>(</td>
<td class="paramtype">const value_type &amp;&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert a delete file into the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The delete file to insert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pair with an iterator to the inserted element (or the existing one) and a bool indicating whether insertion took place </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/util/<a class="el" href="data__file__set_8h_source.html">data_file_set.h</a></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>