blob: f3dc981a3babac0a2019b763496c249fb4ecaded [file] [log] [blame]
<!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/row/struct_like.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_736f5aa46d5d53763bf6a073a47459a7.html">row</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">struct_like.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;span&gt;</code><br />
<code>#include &lt;string_view&gt;</code><br />
<code>#include &lt;variant&gt;</code><br />
<code>#include &quot;iceberg/expression/literal.h&quot;</code><br />
<code>#include &quot;iceberg/result.h&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="decimal_8h_source.html">iceberg/util/decimal.h</a>&quot;</code><br />
</div>
<p><a href="struct__like_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_1StructLike.html">iceberg::StructLike</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable struct-like wrapper. <a href="classiceberg_1_1StructLike.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_1ArrayLike.html">iceberg::ArrayLike</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable array-like wrapper. <a href="classiceberg_1_1ArrayLike.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_1MapLike.html">iceberg::MapLike</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An immutable map-like wrapper. <a href="classiceberg_1_1MapLike.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_1StructLikeAccessor.html">iceberg::StructLikeAccessor</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An accessor for a struct-like object. <a href="classiceberg_1_1StructLikeAccessor.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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3b5162f202989971e28bc310237964db" id="r_a3b5162f202989971e28bc310237964db"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">iceberg::Scalar</a> = std::variant&lt; std::monostate, bool, int32_t, int64_t, float, double, std::string_view, <a class="el" href="classiceberg_1_1Decimal.html">Decimal</a>, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1StructLike.html">StructLike</a> &gt;, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1ArrayLike.html">ArrayLike</a> &gt;, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1MapLike.html">MapLike</a> &gt; &gt;</td></tr>
<tr class="memdesc:a3b5162f202989971e28bc310237964db"><td class="mdescLeft">&#160;</td><td class="mdescRight">A scalar value depending on its data type. <br /></td></tr>
<tr class="separator:a3b5162f202989971e28bc310237964db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa0624b400dcf8eb7e885cda545b9c593" id="r_aa0624b400dcf8eb7e885cda545b9c593"><td class="memItemLeft" align="right" valign="top"><a id="aa0624b400dcf8eb7e885cda545b9c593" name="aa0624b400dcf8eb7e885cda545b9c593"></a>
Result&lt; <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">Scalar</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::LiteralToScalar</b> (const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &amp;literal)</td></tr>
<tr class="memdesc:aa0624b400dcf8eb7e885cda545b9c593"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a <a class="el" href="classiceberg_1_1Literal.html" title="Literal is a literal value that is associated with a primitive type.">Literal</a> to a Scalar. <br /></td></tr>
<tr class="separator:aa0624b400dcf8eb7e885cda545b9c593"><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>Structures for viewing data in a row-based format. This header contains the definition of StructLike, ArrayLike, and MapLike which provide an unified interface for viewing data from <a class="el" href="structArrowArray.html">ArrowArray</a> or structs like ManifestFile and ManifestEntry. Note that they do not carry type information and should be used in conjunction with the schema to get the type information. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a3b5162f202989971e28bc310237964db" name="a3b5162f202989971e28bc310237964db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b5162f202989971e28bc310237964db">&#9670;&#160;</a></span>Scalar</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="struct__like_8h.html#a3b5162f202989971e28bc310237964db">iceberg::Scalar</a> = typedef std::variant&lt;std::monostate, bool, int32_t, int64_t, float, double, std::string_view, Decimal, std::shared_ptr&lt;StructLike&gt;, std::shared_ptr&lt;ArrayLike&gt;, std::shared_ptr&lt;MapLike&gt; &gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>A scalar value depending on its data type. </p>
<p>Note that all string and binary values are stored as non-owned string_view and their lifetime is managed by the wrapped object. </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>