cereal/assets/doxygen/classcereal_1_1DeferredData.html
2022-02-27 19:48:38 -08:00

179 lines
9.4 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: cereal::DeferredData&lt; T &gt; Class Template 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&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"><b>cereal</b></li><li class="navelem"><a class="el" href="classcereal_1_1DeferredData.html">DeferredData</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classcereal_1_1DeferredData-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::DeferredData&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A wrapper around data that should be serialized after all non-deferred data.
<a href="classcereal_1_1DeferredData.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="helpers_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/details/helpers.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cereal::DeferredData&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classcereal_1_1DeferredData.png" usemap="#cereal::DeferredData_3C_20T_20_3E_map" alt=""/>
<map id="cereal::DeferredData_3C_20T_20_3E_map" name="cereal::DeferredData_3C_20T_20_3E_map">
<area href="structcereal_1_1detail_1_1DeferredDataCore.html" alt="cereal::detail::DeferredDataCore" shape="rect" coords="0,0,195,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abb8804a82675ae86a3c78efc06a2a2de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1DeferredData.html#abb8804a82675ae86a3c78efc06a2a2de">DeferredData</a> (T &amp;&amp;v)</td></tr>
<tr class="memdesc:abb8804a82675ae86a3c78efc06a2a2de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classcereal_1_1NameValuePair.html" title="For holding name value pairs.">NameValuePair</a>. <a href="classcereal_1_1DeferredData.html#abb8804a82675ae86a3c78efc06a2a2de">More...</a><br /></td></tr>
<tr class="separator:abb8804a82675ae86a3c78efc06a2a2de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a04a4ede9f2c93d416938d87db5d69ccc"><td class="memItemLeft" align="right" valign="top"><a id="a04a4ede9f2c93d416938d87db5d69ccc"></a>
Type&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:a04a4ede9f2c93d416938d87db5d69ccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:gafc913c738d15fc5dd7f4a7a20edb5225"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:gafc913c738d15fc5dd7f4a7a20edb5225"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1DeferredData.html">DeferredData</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Utility.html#gafc913c738d15fc5dd7f4a7a20edb5225">defer</a> (T &amp;&amp;value)</td></tr>
<tr class="memdesc:gafc913c738d15fc5dd7f4a7a20edb5225"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marks data for deferred serialization. <a href="group__Utility.html#gafc913c738d15fc5dd7f4a7a20edb5225">More...</a><br /></td></tr>
<tr class="separator:gafc913c738d15fc5dd7f4a7a20edb5225"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T&gt;<br />
class cereal::DeferredData&lt; T &gt;</h3>
<p>A wrapper around data that should be serialized after all non-deferred data. </p>
<p>This class is used to demarcate data that can only be safely serialized after any data not wrapped in this class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abb8804a82675ae86a3c78efc06a2a2de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb8804a82675ae86a3c78efc06a2a2de">&#9670;&nbsp;</a></span>DeferredData()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcereal_1_1DeferredData.html">cereal::DeferredData</a>&lt; T &gt;::<a class="el" href="classcereal_1_1DeferredData.html">DeferredData</a> </td>
<td>(</td>
<td class="paramtype">T &amp;&amp;&#160;</td>
<td class="paramname"><em>v</em></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>Constructs a new <a class="el" href="classcereal_1_1NameValuePair.html" title="For holding name value pairs.">NameValuePair</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>The value to defer. Ideally this should be an l-value reference so that the value can be both loaded and saved to. If you pass an r-value reference, the <a class="el" href="classcereal_1_1DeferredData.html" title="A wrapper around data that should be serialized after all non-deferred data.">DeferredData</a> will store a copy of it instead of a reference. Thus you should only pass r-values in cases where this makes sense, such as the result of some size() call. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="helpers_8hpp_source.html">helpers.hpp</a></li>
<li><a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
</ul>
</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 &#160;<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>