blob: d438ac1739ecf3182eb67b90396845ffc640add6 [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/expression/literal.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><li class="navelem"><a class="el" href="dir_7ac1409b17bc67cf1cb6672572f7a9bb.html">expression</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="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">literal.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Define typed literal values used by expressions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;compare&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;variant&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &quot;<a class="el" href="iceberg__export_8h_source.html">iceberg/iceberg_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type_8h_source.html">iceberg/type.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="decimal_8h_source.html">iceberg/util/decimal.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="formattable_8h_source.html">iceberg/util/formattable.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="int128_8h_source.html">iceberg/util/int128.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="uuid_8h_source.html">iceberg/util/uuid.h</a>&quot;</code><br />
</div>
<p><a href="literal_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_1Literal.html">iceberg::Literal</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a> is a literal value that is associated with a primitive type. <a href="classiceberg_1_1Literal.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_1Literal_1_1BelowMin.html">iceberg::Literal::BelowMin</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sentinel value to indicate that the literal value is below the valid range of a specific primitive type. It can happen when casting a literal to a narrower primitive type. <a href="structiceberg_1_1Literal_1_1BelowMin.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_1Literal_1_1AboveMax.html">iceberg::Literal::AboveMax</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sentinel value to indicate that the literal value is above the valid range of a specific primitive type. It can happen when casting a literal to a narrower primitive type. <a href="structiceberg_1_1Literal_1_1AboveMax.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_1LiteralValueHash.html">iceberg::LiteralValueHash</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash function for <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a> to facilitate use in unordered containers. <a href="structiceberg_1_1LiteralValueHash.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_1LiteralHash.html">iceberg::LiteralHash</a></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_1LiteralTraits.html">iceberg::LiteralTraits&lt; type_id &gt;</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="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="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad65959822bd9f989788a235caf8500d6" id="r_ad65959822bd9f989788a235caf8500d6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="literal_8h.html#ad65959822bd9f989788a235caf8500d6">DEFINE_LITERAL_TRAIT</a>(TYPE_ID, VALUE_TYPE)</td></tr>
<tr class="separator:ad65959822bd9f989788a235caf8500d6"><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 typed literal values used by expressions. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ad65959822bd9f989788a235caf8500d6" name="ad65959822bd9f989788a235caf8500d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad65959822bd9f989788a235caf8500d6">&#9670;&#160;</a></span>DEFINE_LITERAL_TRAIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFINE_LITERAL_TRAIT</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">TYPE_ID, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">VALUE_TYPE&#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">template</span> &lt;&gt; \</div>
<div class="line"> <span class="keyword">struct </span>LiteralTraits&lt;TypeId::TYPE_ID&gt; { \</div>
<div class="line"> <span class="keyword">using </span>ValueType = VALUE_TYPE; \</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>