Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/result_8h.html
blob: 6374ca9fb8e5682b3f27f99b660d4ec47e939074 [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/result.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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#concepts">Concepts</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">result.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define Result, Status, and error helpers.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;expected&gt;</code><br />
<code>#include &lt;format&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
</div>
<p><a href="result_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1Error.html">iceberg::Error</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structiceberg_1_1Error.html" title="Error with a kind and a message.">Error</a> with a kind and a message. <a href="structiceberg_1_1Error.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1DefaultError.html">iceberg::DefaultError&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">/brief Default error trait <a href="structiceberg_1_1DefaultError.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="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <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="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concepticeberg_1_1AsResult.html">iceberg::AsResult</a></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:a6ca8899014a60b322118d779e12948ab" id="r_a6ca8899014a60b322118d779e12948ab"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="result_8h.html#a6ca8899014a60b322118d779e12948ab">DEFINE_ERROR_FUNCTION</a>(name)</td></tr>
<tr class="memdesc:a6ca8899014a60b322118d779e12948ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to define error creation functions. <br /></td></tr>
<tr class="separator:a6ca8899014a60b322118d779e12948ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a9d5594e371beb516b0120e07e69d3af6" id="r_a9d5594e371beb516b0120e07e69d3af6"><td class="memTemplParams" colspan="2"><a id="a9d5594e371beb516b0120e07e69d3af6" name="a9d5594e371beb516b0120e07e69d3af6"></a>
template&lt;typename T , typename E = typename DefaultError&lt;T&gt;::type&gt; </td></tr>
<tr class="memitem:a9d5594e371beb516b0120e07e69d3af6"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::Result</b> = std::expected&lt; T, E &gt;</td></tr>
<tr class="memdesc:a9d5594e371beb516b0120e07e69d3af6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Result alias. <br /></td></tr>
<tr class="separator:a9d5594e371beb516b0120e07e69d3af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3f9de7ab4768207166ea7cdbe3e5f59" id="r_ab3f9de7ab4768207166ea7cdbe3e5f59"><td class="memItemLeft" align="right" valign="top"><a id="ab3f9de7ab4768207166ea7cdbe3e5f59" name="ab3f9de7ab4768207166ea7cdbe3e5f59"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::Status</b> = <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; void &gt;</td></tr>
<tr class="separator:ab3f9de7ab4768207166ea7cdbe3e5f59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa007ef946d814476761bd65ef475a8d2" id="r_aa007ef946d814476761bd65ef475a8d2"><td class="memTemplParams" colspan="2"><a id="aa007ef946d814476761bd65ef475a8d2" name="aa007ef946d814476761bd65ef475a8d2"></a>
template&lt;AsResult T&gt; </td></tr>
<tr class="memitem:aa007ef946d814476761bd65ef475a8d2"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::ResultValueT</b> = typename std::remove_cvref_t&lt; T &gt;::value_type</td></tr>
<tr class="separator:aa007ef946d814476761bd65ef475a8d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a5cf8d9de1acce830ff4fc3d87fe95147" id="r_a5cf8d9de1acce830ff4fc3d87fe95147"><td class="memItemLeft" align="right" valign="top"><a id="a5cf8d9de1acce830ff4fc3d87fe95147" name="a5cf8d9de1acce830ff4fc3d87fe95147"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html#a5cf8d9de1acce830ff4fc3d87fe95147">iceberg::ErrorKind</a> { <br />
&#160;&#160;<b>kAlreadyExists</b>
, <b>kAuthenticationFailed</b>
, <b>kBadRequest</b>
, <b>kCommitFailed</b>
, <br />
&#160;&#160;<b>kCommitStateUnknown</b>
, <b>kDecompressError</b>
, <b>kForbidden</b>
, <b>kInternalServerError</b>
, <br />
&#160;&#160;<b>kInvalid</b>
, <b>kInvalidArgument</b>
, <b>kInvalidArrowData</b>
, <b>kInvalidExpression</b>
, <br />
&#160;&#160;<b>kInvalidManifest</b>
, <b>kInvalidManifestList</b>
, <b>kInvalidSchema</b>
, <b>kIOError</b>
, <br />
&#160;&#160;<b>kJsonParseError</b>
, <b>kNamespaceNotEmpty</b>
, <b>kNoSuchNamespace</b>
, <b>kNoSuchPlanId</b>
, <br />
&#160;&#160;<b>kNoSuchPlanTask</b>
, <b>kNoSuchTable</b>
, <b>kNoSuchWarehouse</b>
, <b>kNoSuchView</b>
, <br />
&#160;&#160;<b>kNotAllowed</b>
, <b>kNotAuthorized</b>
, <b>kNotFound</b>
, <b>kNotImplemented</b>
, <br />
&#160;&#160;<b>kNotSupported</b>
, <b>kRestError</b>
, <b>kRetryableValidationFailed</b>
, <b>kServiceUnavailable</b>
, <br />
&#160;&#160;<b>kTokenExpired</b>
, <b>kUnknownError</b>
, <b>kValidationFailed</b>
<br />
}</td></tr>
<tr class="memdesc:a5cf8d9de1acce830ff4fc3d87fe95147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error types for iceberg. <br /></td></tr>
<tr class="separator:a5cf8d9de1acce830ff4fc3d87fe95147"><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>Define Result, Status, and error helpers. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a6ca8899014a60b322118d779e12948ab" name="a6ca8899014a60b322118d779e12948ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ca8899014a60b322118d779e12948ab">&#9670;&#160;</a></span>DEFINE_ERROR_FUNCTION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFINE_ERROR_FUNCTION</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt; \</div>
<div class="line"> <span class="keyword">inline</span> <span class="keyword">auto</span> name(<span class="keyword">const</span> std::format_string&lt;Args...&gt; fmt, Args&amp;&amp;... args) \</div>
<div class="line"> -&gt; std::unexpected&lt;Error&gt; { \</div>
<div class="line"> <span class="keywordflow">return</span> std::unexpected&lt;Error&gt;( \</div>
<div class="line"> {ErrorKind::k##name, std::format(fmt, std::forward&lt;Args&gt;(args)...)}); \</div>
<div class="line"> } \</div>
<div class="line"> <span class="keyword">inline</span> <span class="keyword">auto</span> name(std::string message) -&gt; std::unexpected&lt;Error&gt; { \</div>
<div class="line"> <span class="keywordflow">return</span> std::unexpected&lt;Error&gt;({ErrorKind::k##name, std::move(message)}); \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>Macro to define error creation functions. </p>
</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>