api/exception_8h.html - iceberg-cpp - Git at Google

 <!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/exception.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>  </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">exception.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><code>#include &lt;stdexcept&gt;</code><br />
 <code>#include &quot;iceberg/iceberg_export.h&quot;</code><br />
 </div>
 <p><a href="exception_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_1IcebergError.html">iceberg::IcebergError</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base exception class for exceptions thrown by the Iceberg library.  <a href="classiceberg_1_1IcebergError.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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ExpressionError.html">iceberg::ExpressionError</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exception thrown when expression construction fails.  <a href="classiceberg_1_1ExpressionError.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:a0ed6cd21ec8a093927ad46552e19158e" id="r_a0ed6cd21ec8a093927ad46552e19158e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="exception_8h.html#a0ed6cd21ec8a093927ad46552e19158e">ICEBERG_CHECK_OR_DIE</a>(condition, ...)</td></tr>
 <tr class="separator:a0ed6cd21ec8a093927ad46552e19158e"><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>Common exception types for Iceberg. Note that this library primarily uses return values for error handling, not exceptions. Some operations, however, will throw exceptions in contexts where no other option is available (e.g. a constructor). In those cases, an exception type from here will be used. </p>
 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 <a id="a0ed6cd21ec8a093927ad46552e19158e" name="a0ed6cd21ec8a093927ad46552e19158e"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a0ed6cd21ec8a093927ad46552e19158e">&#9670;&#160;</a></span>ICEBERG_CHECK_OR_DIE</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">#define ICEBERG_CHECK_OR_DIE</td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
           <td class="paramname">condition, </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 (!(condition)) [[unlikely]] {                         \</div>
 <div class="line">      <span class="keywordflow">throw</span> <a class="code hl_class" href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a>(std::format(__VA_ARGS__)); \</div>
 <div class="line">    }                                                        \</div>
 <div class="line">  } <span class="keywordflow">while</span> (0)</div>
 <div class="ttc" id="aclassiceberg_1_1IcebergError_html"><div class="ttname"><a href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a></div><div class="ttdoc">Base exception class for exceptions thrown by the Iceberg library.</div><div class="ttdef"><b>Definition</b> exception.h:36</div></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>
	<!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/exception.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&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>
	<!-- 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="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#define-members">Macros</a> </div>
	<div class="headertitle"><div class="title">exception.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><code>#include <stdexcept></code><br />
	<code>#include "iceberg/iceberg_export.h"</code><br />
	</div>
	<p><a href="exception_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base exception class for exceptions thrown by the Iceberg library. <a href="classiceberg_1_1IcebergError.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ExpressionError.html">iceberg::ExpressionError</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Exception thrown when expression construction fails. <a href="classiceberg_1_1ExpressionError.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a0ed6cd21ec8a093927ad46552e19158e" id="r_a0ed6cd21ec8a093927ad46552e19158e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="exception_8h.html#a0ed6cd21ec8a093927ad46552e19158e">ICEBERG_CHECK_OR_DIE</a>(condition, ...)</td></tr>
	<tr class="separator:a0ed6cd21ec8a093927ad46552e19158e"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Common exception types for Iceberg. Note that this library primarily uses return values for error handling, not exceptions. Some operations, however, will throw exceptions in contexts where no other option is available (e.g. a constructor). In those cases, an exception type from here will be used. </p>
	</div><h2 class="groupheader">Macro Definition Documentation</h2>
	<a id="a0ed6cd21ec8a093927ad46552e19158e" name="a0ed6cd21ec8a093927ad46552e19158e"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a0ed6cd21ec8a093927ad46552e19158e">◆ </a></span>ICEBERG_CHECK_OR_DIE</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">#define ICEBERG_CHECK_OR_DIE</td>
	<td>(</td>
	<td class="paramtype"> </td>
	<td class="paramname">condition, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype"> </td>
	<td class="paramname"><em>...</em> </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 (!(condition)) [[unlikely]] { \</div>
	<div class="line"> <span class="keywordflow">throw</span> <a class="code hl_class" href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a>(std::format(__VA_ARGS__)); \</div>
	<div class="line"> } \</div>
	<div class="line"> } <span class="keywordflow">while</span> (0)</div>
	<div class="ttc" id="aclassiceberg_1_1IcebergError_html"><div class="ttname"><a href="classiceberg_1_1IcebergError.html">iceberg::IcebergError</a></div><div class="ttdoc">Base exception class for exceptions thrown by the Iceberg library.</div><div class="ttdef"><b>Definition</b> exception.h:36</div></div>
	</div><!-- fragment -->
	</div>
	</div>
	</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>