| <!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 Source File</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&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">result.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <expected></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <format></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "iceberg/iceberg_export.h"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">namespace </span>iceberg {</div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">enum class</span> ErrorKind {</div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> kAlreadyExists,</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> kAuthenticationFailed,</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> kBadRequest,</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> kCommitFailed,</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> kCommitStateUnknown,</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> kDecompressError,</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> kForbidden,</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> kInternalServerError,</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> kInvalid, <span class="comment">// For general invalid errors</span></div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> kInvalidArgument,</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> kInvalidArrowData,</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> kInvalidExpression,</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> kInvalidManifest,</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> kInvalidManifestList,</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> kInvalidSchema,</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> kIOError,</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> kJsonParseError,</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> kNamespaceNotEmpty,</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> kNoSuchNamespace,</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> kNoSuchTable,</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> kNoSuchView,</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> kNotAllowed,</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> kNotAuthorized,</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> kNotFound,</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> kNotImplemented,</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> kNotSupported,</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> kRestError,</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> kServiceUnavailable,</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> kTokenExpired,</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> kUnknownError,</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> kValidationFailed,</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>};</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="foldopen" id="foldopen00066" data-start="{" data-end="};"> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structiceberg_1_1Error.html"> 66</a></span><span class="keyword">struct </span>ICEBERG_EXPORT [[nodiscard]] <a class="code hl_struct" href="structiceberg_1_1Error.html">Error</a> {</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> ErrorKind kind;</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> std::string message;</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>};</div> |
| </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="foldopen" id="foldopen00073" data-start="{" data-end="};"> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="structiceberg_1_1DefaultError.html"> 73</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structiceberg_1_1DefaultError.html">DefaultError</a> {</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">using </span><a class="code hl_struct" href="structiceberg_1_1Error.html">type</a> = <a class="code hl_struct" href="structiceberg_1_1Error.html">Error</a>;</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>};</div> |
| </div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>template <typename T, typename E = typename DefaultError<T>::type></div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="keyword">using </span>Result = std::expected<T, E>;</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="keyword">using </span>Status = Result<void>;</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="preprocessor">#define DEFINE_ERROR_FUNCTION(name) \</span></div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor"> template <typename... Args> \</span></div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="preprocessor"> inline auto name(const std::format_string<Args...> fmt, Args&&... args) \</span></div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor"> -> std::unexpected<Error> { \</span></div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor"> return std::unexpected<Error>( \</span></div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="preprocessor"> {ErrorKind::k##name, std::format(fmt, std::forward<Args>(args)...)}); \</span></div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor"> } \</span></div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor"> inline auto name(std::string message) -> std::unexpected<Error> { \</span></div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor"> return std::unexpected<Error>({ErrorKind::k##name, std::move(message)}); \</span></div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor"> }</span></div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>DEFINE_ERROR_FUNCTION(AlreadyExists)</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span>DEFINE_ERROR_FUNCTION(AuthenticationFailed)</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>DEFINE_ERROR_FUNCTION(BadRequest)</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>DEFINE_ERROR_FUNCTION(CommitFailed)</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>DEFINE_ERROR_FUNCTION(CommitStateUnknown)</div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span>DEFINE_ERROR_FUNCTION(DecompressError)</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>DEFINE_ERROR_FUNCTION(Forbidden)</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span>DEFINE_ERROR_FUNCTION(InternalServerError)</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>DEFINE_ERROR_FUNCTION(Invalid)</div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>DEFINE_ERROR_FUNCTION(InvalidArgument)</div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>DEFINE_ERROR_FUNCTION(InvalidArrowData)</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>DEFINE_ERROR_FUNCTION(InvalidExpression)</div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>DEFINE_ERROR_FUNCTION(InvalidManifest)</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>DEFINE_ERROR_FUNCTION(InvalidManifestList)</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>DEFINE_ERROR_FUNCTION(InvalidSchema)</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span>DEFINE_ERROR_FUNCTION(IOError)</div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>DEFINE_ERROR_FUNCTION(JsonParseError)</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>DEFINE_ERROR_FUNCTION(NamespaceNotEmpty)</div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span>DEFINE_ERROR_FUNCTION(NoSuchNamespace)</div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span>DEFINE_ERROR_FUNCTION(NoSuchTable)</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span>DEFINE_ERROR_FUNCTION(NoSuchView)</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span>DEFINE_ERROR_FUNCTION(NotAllowed)</div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>DEFINE_ERROR_FUNCTION(NotAuthorized)</div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>DEFINE_ERROR_FUNCTION(NotFound)</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>DEFINE_ERROR_FUNCTION(NotImplemented)</div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>DEFINE_ERROR_FUNCTION(NotSupported)</div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span>DEFINE_ERROR_FUNCTION(RestError)</div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span>DEFINE_ERROR_FUNCTION(ServiceUnavailable)</div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>DEFINE_ERROR_FUNCTION(TokenExpired)</div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span>DEFINE_ERROR_FUNCTION(UnknownError)</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span>DEFINE_ERROR_FUNCTION(ValidationFailed)</div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#undef DEFINE_ERROR_FUNCTION</span></div> |
| <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="astructiceberg_1_1DefaultError_html"><div class="ttname"><a href="structiceberg_1_1DefaultError.html">iceberg::DefaultError</a></div><div class="ttdoc">/brief Default error trait</div><div class="ttdef"><b>Definition</b> result.h:73</div></div> |
| <div class="ttc" id="astructiceberg_1_1Error_html"><div class="ttname"><a href="structiceberg_1_1Error.html">iceberg::Error</a></div><div class="ttdoc">Error with a kind and a message.</div><div class="ttdef"><b>Definition</b> result.h:66</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
