mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:02:00 +02:00
183 lines
12 KiB
HTML
183 lines
12 KiB
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">
|
|
<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>cereal: common.hpp 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">cereal
|
|
</div>
|
|
<div id="projectbrief">A C++11 library for serialization</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&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&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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d445d0c097210746bce3afd9a77bcad9.html">cereal</a></li><li class="navelem"><a class="el" href="dir_056182efa28390c8a7ef83cb1836ec86.html">types</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">common.hpp File Reference<div class="ingroups"><a class="el" href="group__TypeSupport.html">Support for Serializing Various Types</a> » <a class="el" href="group__OtherTypes.html">Miscellaneous Types Support</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Support common types - always included automatically.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="cereal_8hpp_source.html">cereal/cereal.hpp</a>"</code><br />
|
|
</div>
|
|
<p><a href="common_8hpp_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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1common__detail_1_1is__enum.html">cereal::common_detail::is_enum< T ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a type is an enum. <a href="classcereal_1_1common__detail_1_1is__enum.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 name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a2abf02f44e6a5c2cd686b84791955fae"><td class="memTemplParams" colspan="2"><a id="a2abf02f44e6a5c2cd686b84791955fae"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a2abf02f44e6a5c2cd686b84791955fae"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#a2abf02f44e6a5c2cd686b84791955fae">cereal::common_detail::serializeArray</a> (Archive &ar, T &array, std::true_type)</td></tr>
|
|
<tr class="memdesc:a2abf02f44e6a5c2cd686b84791955fae"><td class="mdescLeft"> </td><td class="mdescRight">Serialization for arrays if <a class="el" href="structcereal_1_1BinaryData.html" title="A wrapper around data that can be serialized in a binary fashion.">BinaryData</a> is supported and we are arithmetic. <br /></td></tr>
|
|
<tr class="separator:a2abf02f44e6a5c2cd686b84791955fae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52dab5e759681d7252858cdadaf2c1e3"><td class="memTemplParams" colspan="2"><a id="a52dab5e759681d7252858cdadaf2c1e3"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a52dab5e759681d7252858cdadaf2c1e3"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#a52dab5e759681d7252858cdadaf2c1e3">cereal::common_detail::serializeArray</a> (Archive &ar, T &array, std::false_type)</td></tr>
|
|
<tr class="memdesc:a52dab5e759681d7252858cdadaf2c1e3"><td class="mdescLeft"> </td><td class="mdescRight">Serialization for arrays if <a class="el" href="structcereal_1_1BinaryData.html" title="A wrapper around data that can be serialized in a binary fashion.">BinaryData</a> is not supported or we are not arithmetic. <br /></td></tr>
|
|
<tr class="separator:a52dab5e759681d7252858cdadaf2c1e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a073d35d55ad8dc81ce149fb799aab9f0"><td class="memTemplParams" colspan="2"><a id="a073d35d55ad8dc81ce149fb799aab9f0"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a073d35d55ad8dc81ce149fb799aab9f0"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if< common_detail::is_enum< T >::value, typename common_detail::is_enum< T >::base_type >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#a073d35d55ad8dc81ce149fb799aab9f0">cereal::CEREAL_SAVE_MINIMAL_FUNCTION_NAME</a> (Archive const &, T const &t)</td></tr>
|
|
<tr class="memdesc:a073d35d55ad8dc81ce149fb799aab9f0"><td class="mdescLeft"> </td><td class="mdescRight">Saving for enum types. <br /></td></tr>
|
|
<tr class="separator:a073d35d55ad8dc81ce149fb799aab9f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa110605d7a57863ad6cf9370332f446d"><td class="memTemplParams" colspan="2"><a id="aa110605d7a57863ad6cf9370332f446d"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:aa110605d7a57863ad6cf9370332f446d"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if< common_detail::is_enum< T >::value, void >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#aa110605d7a57863ad6cf9370332f446d">cereal::CEREAL_LOAD_MINIMAL_FUNCTION_NAME</a> (Archive const &, T &&t, typename common_detail::is_enum< T >::base_type const &value)</td></tr>
|
|
<tr class="memdesc:aa110605d7a57863ad6cf9370332f446d"><td class="mdescLeft"> </td><td class="mdescRight">Loading for enum types. <br /></td></tr>
|
|
<tr class="separator:aa110605d7a57863ad6cf9370332f446d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a676a85ac8cfcd512a743f930a10b6770"><td class="memTemplParams" colspan="2">template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a676a85ac8cfcd512a743f930a10b6770"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#a676a85ac8cfcd512a743f930a10b6770">cereal::CEREAL_SERIALIZE_FUNCTION_NAME</a> (Archive &, T *&)</td></tr>
|
|
<tr class="memdesc:a676a85ac8cfcd512a743f930a10b6770"><td class="mdescLeft"> </td><td class="mdescRight">Serialization for raw pointers. <a href="common_8hpp.html#a676a85ac8cfcd512a743f930a10b6770">More...</a><br /></td></tr>
|
|
<tr class="separator:a676a85ac8cfcd512a743f930a10b6770"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22053a71b907666422b3a281be15bbc0"><td class="memTemplParams" colspan="2"><a id="a22053a71b907666422b3a281be15bbc0"></a>
|
|
template<class Archive , class T > </td></tr>
|
|
<tr class="memitem:a22053a71b907666422b3a281be15bbc0"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if< std::is_array< T >::value, void >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="common_8hpp.html#a22053a71b907666422b3a281be15bbc0">cereal::CEREAL_SERIALIZE_FUNCTION_NAME</a> (Archive &ar, T &array)</td></tr>
|
|
<tr class="memdesc:a22053a71b907666422b3a281be15bbc0"><td class="mdescLeft"> </td><td class="mdescRight">Serialization for C style arrays. <br /></td></tr>
|
|
<tr class="separator:a22053a71b907666422b3a281be15bbc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Support common types - always included automatically. </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a676a85ac8cfcd512a743f930a10b6770"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a676a85ac8cfcd512a743f930a10b6770">◆ </a></span>CEREAL_SERIALIZE_FUNCTION_NAME()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class Archive , class T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void cereal::CEREAL_SERIALIZE_FUNCTION_NAME </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Archive & </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T *& </td>
|
|
<td class="paramname"> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Serialization for raw pointers. </p>
|
|
<p>This exists only to throw a static_assert to let users know we don't support raw pointers. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.3.1-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Feb 27 2022 19:46:46 for cereal by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-42360142-1', 'uscilab.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|