Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/error__collector_8h.html
blob: a6e3db6b5cd0c536d54ecd1a9aeec85613e3eb03 [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/util/error_collector.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><li class="navelem"><a class="el" href="dir_7a408d6a2d81183c3eacfe2576f2a2aa.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">error_collector.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;iceberg/iceberg_export.h&quot;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
</div>
<p><a href="error__collector_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="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ErrorCollector.html">iceberg::ErrorCollector</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for collecting errors in the builder pattern. <a href="classiceberg_1_1ErrorCollector.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a98c909760a122c83bf1a9c125efeb6d5" id="r_a98c909760a122c83bf1a9c125efeb6d5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#a98c909760a122c83bf1a9c125efeb6d5">ICEBERG_BUILDER_RETURN_IF_ERROR</a>(result)</td></tr>
<tr class="separator:a98c909760a122c83bf1a9c125efeb6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae46878e9e4858bd4ad91da1b87d1c582" id="r_ae46878e9e4858bd4ad91da1b87d1c582"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#ae46878e9e4858bd4ad91da1b87d1c582">ICEBERG_BUILDER_ASSIGN_OR_RETURN_IMPL</a>(result_name, lhs, rexpr)</td></tr>
<tr class="separator:ae46878e9e4858bd4ad91da1b87d1c582"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a264cf9c01481467b351ea2d2ae7194e6" id="r_a264cf9c01481467b351ea2d2ae7194e6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#a264cf9c01481467b351ea2d2ae7194e6">ICEBERG_BUILDER_ASSIGN_OR_RETURN</a>(lhs, rexpr)</td></tr>
<tr class="separator:a264cf9c01481467b351ea2d2ae7194e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a869bf8b274f803178b4334a5481700fd" id="r_a869bf8b274f803178b4334a5481700fd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#a869bf8b274f803178b4334a5481700fd">ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR_IMPL</a>(result_name, lhs, rexpr, ...)</td></tr>
<tr class="separator:a869bf8b274f803178b4334a5481700fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e1af0701f6c28c368188435296ec49" id="r_a09e1af0701f6c28c368188435296ec49"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#a09e1af0701f6c28c368188435296ec49">ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR</a>(lhs, rexpr, ...)</td></tr>
<tr class="separator:a09e1af0701f6c28c368188435296ec49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b9826108d32e0c95b450cb10f29e9ad" id="r_a4b9826108d32e0c95b450cb10f29e9ad"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error__collector_8h.html#a4b9826108d32e0c95b450cb10f29e9ad">ICEBERG_BUILDER_CHECK</a>(expr, ...)</td></tr>
<tr class="separator:a4b9826108d32e0c95b450cb10f29e9ad"><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>Base class for collecting validation errors in builder patterns </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a264cf9c01481467b351ea2d2ae7194e6" name="a264cf9c01481467b351ea2d2ae7194e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a264cf9c01481467b351ea2d2ae7194e6">&#9670;&#160;</a></span>ICEBERG_BUILDER_ASSIGN_OR_RETURN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_ASSIGN_OR_RETURN</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ICEBERG_BUILDER_ASSIGN_OR_RETURN_IMPL( \</div>
<div class="line"> ICEBERG_ASSIGN_OR_RAISE_NAME(result_, __COUNTER__), lhs, rexpr)</div>
</div><!-- fragment -->
</div>
</div>
<a id="ae46878e9e4858bd4ad91da1b87d1c582" name="ae46878e9e4858bd4ad91da1b87d1c582"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae46878e9e4858bd4ad91da1b87d1c582">&#9670;&#160;</a></span>ICEBERG_BUILDER_ASSIGN_OR_RETURN_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_ASSIGN_OR_RETURN_IMPL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">result_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">auto</span>&amp;&amp; result_name = (rexpr); \</div>
<div class="line"> ICEBERG_BUILDER_RETURN_IF_ERROR(result_name) \</div>
<div class="line"> lhs = std::move(result_name.value());</div>
</div><!-- fragment -->
</div>
</div>
<a id="a09e1af0701f6c28c368188435296ec49" name="a09e1af0701f6c28c368188435296ec49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e1af0701f6c28c368188435296ec49">&#9670;&#160;</a></span>ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR_IMPL( \</div>
<div class="line"> ICEBERG_ASSIGN_OR_RAISE_NAME(result_, __COUNTER__), lhs, rexpr, __VA_ARGS__)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a869bf8b274f803178b4334a5481700fd" name="a869bf8b274f803178b4334a5481700fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a869bf8b274f803178b4334a5481700fd">&#9670;&#160;</a></span>ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR_IMPL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_ASSIGN_OR_RETURN_WITH_ERROR_IMPL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">result_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lhs, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">rexpr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">auto</span>&amp;&amp; result_name = (rexpr); \</div>
<div class="line"> if (!result_name) [[unlikely]] { \</div>
<div class="line"> <span class="keywordflow">return</span> AddError(ErrorKind::kInvalidArgument, __VA_ARGS__); \</div>
<div class="line"> } \</div>
<div class="line"> lhs = std::move(result_name.value());</div>
</div><!-- fragment -->
</div>
</div>
<a id="a4b9826108d32e0c95b450cb10f29e9ad" name="a4b9826108d32e0c95b450cb10f29e9ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b9826108d32e0c95b450cb10f29e9ad">&#9670;&#160;</a></span>ICEBERG_BUILDER_CHECK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_CHECK</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">expr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>...</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">do</span> { \</div>
<div class="line"> if (!(expr)) [[unlikely]] { \</div>
<div class="line"> <span class="keywordflow">return</span> AddError(ErrorKind::kInvalidArgument, __VA_ARGS__); \</div>
<div class="line"> } \</div>
<div class="line"> } <span class="keywordflow">while</span> (<span class="keyword">false</span>)</div>
</div><!-- fragment -->
</div>
</div>
<a id="a98c909760a122c83bf1a9c125efeb6d5" name="a98c909760a122c83bf1a9c125efeb6d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98c909760a122c83bf1a9c125efeb6d5">&#9670;&#160;</a></span>ICEBERG_BUILDER_RETURN_IF_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ICEBERG_BUILDER_RETURN_IF_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">result</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordflow">if</span> (<span class="keyword">auto</span>&amp;&amp; result_name = result; !result_name) [[unlikely]] { \</div>
<div class="line"> errors_.emplace_back(std::move(result_name.error())); \</div>
<div class="line"> <span class="keywordflow">return</span> *<span class="keyword">this</span>; \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</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>