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

227 lines
13 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: binary.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&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_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_897bf859d07ca0c5bf51a1d2c31d0ee1.html">archives</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">binary.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary input and output archives.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="cereal_8hpp_source.html">cereal/cereal.hpp</a>&quot;</code><br />
<code>#include &lt;sstream&gt;</code><br />
</div>
<p><a href="binary_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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An output archive designed to save data in a compact binary representation. <a href="classcereal_1_1BinaryOutputArchive.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="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An input archive designed to load data saved using <a class="el" href="classcereal_1_1BinaryOutputArchive.html" title="An output archive designed to save data in a compact binary representation.">BinaryOutputArchive</a>. <a href="classcereal_1_1BinaryInputArchive.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8aeb7b414512d91291d759aaa284a8c2"><td class="memTemplParams" colspan="2"><a id="a8aeb7b414512d91291d759aaa284a8c2"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a8aeb7b414512d91291d759aaa284a8c2"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt; std::is_arithmetic&lt; T &gt;::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#a8aeb7b414512d91291d759aaa284a8c2">cereal::CEREAL_SAVE_FUNCTION_NAME</a> (BinaryOutputArchive &amp;ar, T const &amp;t)</td></tr>
<tr class="memdesc:a8aeb7b414512d91291d759aaa284a8c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving for POD types to binary. <br /></td></tr>
<tr class="separator:a8aeb7b414512d91291d759aaa284a8c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d9235c50bdb3961865274a086dda972"><td class="memTemplParams" colspan="2"><a id="a4d9235c50bdb3961865274a086dda972"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a4d9235c50bdb3961865274a086dda972"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt; std::is_arithmetic&lt; T &gt;::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#a4d9235c50bdb3961865274a086dda972">cereal::CEREAL_LOAD_FUNCTION_NAME</a> (BinaryInputArchive &amp;ar, T &amp;t)</td></tr>
<tr class="memdesc:a4d9235c50bdb3961865274a086dda972"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loading for POD types from binary. <br /></td></tr>
<tr class="separator:a4d9235c50bdb3961865274a086dda972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64ec0a04e5dc57a58de5e78b5a87b8d3"><td class="memTemplParams" colspan="2">template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a64ec0a04e5dc57a58de5e78b5a87b8d3"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#a64ec0a04e5dc57a58de5e78b5a87b8d3">cereal::CEREAL_SERIALIZE_FUNCTION_NAME</a> (Archive &amp;ar, NameValuePair&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:a64ec0a04e5dc57a58de5e78b5a87b8d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializing NVP types to binary. <a href="binary_8hpp.html#a64ec0a04e5dc57a58de5e78b5a87b8d3">More...</a><br /></td></tr>
<tr class="separator:a64ec0a04e5dc57a58de5e78b5a87b8d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5fb9b1468920e7e23cb2817e65fed4a"><td class="memTemplParams" colspan="2">template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:ac5fb9b1468920e7e23cb2817e65fed4a"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#ac5fb9b1468920e7e23cb2817e65fed4a">cereal::CEREAL_SERIALIZE_FUNCTION_NAME</a> (Archive &amp;ar, SizeTag&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:ac5fb9b1468920e7e23cb2817e65fed4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializing SizeTags to binary. <a href="binary_8hpp.html#ac5fb9b1468920e7e23cb2817e65fed4a">More...</a><br /></td></tr>
<tr class="separator:ac5fb9b1468920e7e23cb2817e65fed4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a189662781a0f3b710901f892d87792d5"><td class="memTemplParams" colspan="2"><a id="a189662781a0f3b710901f892d87792d5"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a189662781a0f3b710901f892d87792d5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#a189662781a0f3b710901f892d87792d5">cereal::CEREAL_SAVE_FUNCTION_NAME</a> (BinaryOutputArchive &amp;ar, BinaryData&lt; T &gt; const &amp;bd)</td></tr>
<tr class="memdesc:a189662781a0f3b710901f892d87792d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving binary data. <br /></td></tr>
<tr class="separator:a189662781a0f3b710901f892d87792d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8577c2834d64922e9460cad77f9a3ac"><td class="memTemplParams" colspan="2"><a id="af8577c2834d64922e9460cad77f9a3ac"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:af8577c2834d64922e9460cad77f9a3ac"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="binary_8hpp.html#af8577c2834d64922e9460cad77f9a3ac">cereal::CEREAL_LOAD_FUNCTION_NAME</a> (BinaryInputArchive &amp;ar, BinaryData&lt; T &gt; &amp;bd)</td></tr>
<tr class="memdesc:af8577c2834d64922e9460cad77f9a3ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loading binary data. <br /></td></tr>
<tr class="separator:af8577c2834d64922e9460cad77f9a3ac"><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>Binary input and output archives. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a64ec0a04e5dc57a58de5e78b5a87b8d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64ec0a04e5dc57a58de5e78b5a87b8d3">&#9670;&nbsp;</a></span>CEREAL_SERIALIZE_FUNCTION_NAME() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Archive , class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cereal::CEREAL_SERIALIZE_FUNCTION_NAME </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>ar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcereal_1_1NameValuePair.html">NameValuePair</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>t</em>&#160;</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>Serializing NVP types to binary. </p>
<p>Serializing NVP types to portable binary. </p>
</div>
</div>
<a id="ac5fb9b1468920e7e23cb2817e65fed4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5fb9b1468920e7e23cb2817e65fed4a">&#9670;&nbsp;</a></span>CEREAL_SERIALIZE_FUNCTION_NAME() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Archive , class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cereal::CEREAL_SERIALIZE_FUNCTION_NAME </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>ar</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcereal_1_1SizeTag.html">SizeTag</a>&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>t</em>&#160;</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>Serializing SizeTags to binary. </p>
<p>Serializing SizeTags to portable binary. </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 &#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>