blob: 2c846705bc035dcc20ea66a7709582133a5eacdd [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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Avro C++: api/AvroTraits.hh 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Avro C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</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">AvroTraits.hh File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;Config.hh&quot;</code><br />
<code>#include &quot;Types.hh&quot;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
</div>
<p><a href="AvroTraits_8hh_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 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="structavro_1_1is__serializable.html">avro::is_serializable&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define an <a class="el" href="structavro_1_1is__serializable.html" title="Define an is_serializable trait for types we can serialize natively.">is_serializable</a> trait for types we can serialize natively. <a href="structavro_1_1is__serializable.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="structavro_1_1is__promotable.html">avro::is_promotable&lt; T &gt;</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="structavro_1_1type__to__avro.html">avro::type_to_avro&lt; T &gt;</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="structavro_1_1is__defined.html">avro::is_defined&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a <code>T</code> is a complete type i.e. <a href="structavro_1_1is__defined.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="structavro_1_1is__not__defined.html">avro::is_not_defined&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to <a class="el" href="structavro_1_1is__defined.html" title="Check if a T is a complete type i.e.">is_defined</a>, but used to check if T is not defined. <a href="structavro_1_1is__not__defined.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 name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceavro"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceavro.html">avro</a></td></tr>
<tr class="memdesc:namespaceavro"><td class="mdescLeft">&#160;</td><td class="mdescRight">A bunch of templates and specializations for encoding and decoding specific types. <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 name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0903907d3254fe1a1a018f4da4ceb04a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>DEFINE_PRIMITIVE</b>(CTYPE, AVROTYPE)</td></tr>
<tr class="separator:a0903907d3254fe1a1a018f4da4ceb04a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc1278d9faa11991322c707e75a92594"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><b>DEFINE_PROMOTABLE_PRIMITIVE</b>(CTYPE, AVROTYPE)</td></tr>
<tr class="separator:abc1278d9faa11991322c707e75a92594"><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>This header contains type traits and similar utilities used by the library. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a0903907d3254fe1a1a018f4da4ceb04a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0903907d3254fe1a1a018f4da4ceb04a">&#9670;&nbsp;</a></span>DEFINE_PRIMITIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFINE_PRIMITIVE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">CTYPE, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">AVROTYPE&#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"> struct is_serializable&lt;CTYPE&gt; : <span class="keyword">public</span> std::true_type {}; \</div>
<div class="line"> \</div>
<div class="line"> template&lt;&gt; \</div>
<div class="line"> struct type_to_avro&lt;CTYPE&gt; { \</div>
<div class="line"> static <span class="keyword">const</span> <a class="code" href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">Type</a> type = AVROTYPE; \</div>
<div class="line"> };</div>
</div><!-- fragment -->
</div>
</div>
<a id="abc1278d9faa11991322c707e75a92594"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc1278d9faa11991322c707e75a92594">&#9670;&nbsp;</a></span>DEFINE_PROMOTABLE_PRIMITIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DEFINE_PROMOTABLE_PRIMITIVE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">CTYPE, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">AVROTYPE&#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"> struct is_promotable&lt;CTYPE&gt; : <span class="keyword">public</span> std::true_type {}; \</div>
<div class="line"> \</div>
<div class="line"> DEFINE_PRIMITIVE(CTYPE, AVROTYPE)</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="anamespaceavro_html_a29e528c3fe1cb5660067a02721fae0b7"><div class="ttname"><a href="namespaceavro.html#a29e528c3fe1cb5660067a02721fae0b7">avro::Type</a></div><div class="ttdeci">Type</div><div class="ttdoc">The &quot;type&quot; for the schema.</div><div class="ttdef"><b>Definition:</b> Types.hh:31</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>