Files
cereal/assets/doxygen/binary_8hpp.html
T
2013-07-05 20:56:22 -07:00

175 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.3.1"/>
<title>cereal: include/cereal/archives/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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 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.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a></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 &lt;cereal/cereal.hpp&gt;</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:a4bbe63a5ea761fb49b47a3b790d7de9d"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4bbe63a5ea761fb49b47a3b790d7de9d"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a4bbe63a5ea761fb49b47a3b790d7de9d"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if<br class="typebreak"/>
&lt; std::is_arithmetic&lt; T &gt;<br class="typebreak"/>
::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::save</b> (BinaryOutputArchive &amp;ar, T const &amp;t)</td></tr>
<tr class="memdesc:a4bbe63a5ea761fb49b47a3b790d7de9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving for POD types to binary. <br/></td></tr>
<tr class="separator:a4bbe63a5ea761fb49b47a3b790d7de9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac105aae16492395ff64a0645b4658c"><td class="memTemplParams" colspan="2"><a class="anchor" id="a6ac105aae16492395ff64a0645b4658c"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a6ac105aae16492395ff64a0645b4658c"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if<br class="typebreak"/>
&lt; std::is_arithmetic&lt; T &gt;<br class="typebreak"/>
::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::load</b> (BinaryInputArchive &amp;ar, T &amp;t)</td></tr>
<tr class="memdesc:a6ac105aae16492395ff64a0645b4658c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loading for POD types from binary. <br/></td></tr>
<tr class="separator:a6ac105aae16492395ff64a0645b4658c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef54ff4b5afaa7967af7cdefecd6f134"><td class="memTemplParams" colspan="2">template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:aef54ff4b5afaa7967af7cdefecd6f134"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::serialize</b> (Archive &amp;ar, NameValuePair&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:aef54ff4b5afaa7967af7cdefecd6f134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializing NVP types to binary. <a href="#aef54ff4b5afaa7967af7cdefecd6f134">More...</a><br/></td></tr>
<tr class="separator:aef54ff4b5afaa7967af7cdefecd6f134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42a7af89d6d5445bf7bdc35daa66d9bb"><td class="memTemplParams" colspan="2">template&lt;class Archive , class T &gt; </td></tr>
<tr class="memitem:a42a7af89d6d5445bf7bdc35daa66d9bb"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::serialize</b> (Archive &amp;ar, SizeTag&lt; T &gt; &amp;t)</td></tr>
<tr class="memdesc:a42a7af89d6d5445bf7bdc35daa66d9bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializing SizeTags to binary. <a href="#a42a7af89d6d5445bf7bdc35daa66d9bb">More...</a><br/></td></tr>
<tr class="separator:a42a7af89d6d5445bf7bdc35daa66d9bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9decd05a0577163a6dc9ca5b5a271689"><td class="memTemplParams" colspan="2"><a class="anchor" id="a9decd05a0577163a6dc9ca5b5a271689"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a9decd05a0577163a6dc9ca5b5a271689"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt; std::is_array<br class="typebreak"/>
&lt; T &gt;::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::save</b> (BinaryOutputArchive &amp;ar, T const &amp;array)</td></tr>
<tr class="memdesc:a9decd05a0577163a6dc9ca5b5a271689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving arrays. <br/></td></tr>
<tr class="separator:a9decd05a0577163a6dc9ca5b5a271689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bb78e24202b2c4c8ca181a842bae409"><td class="memTemplParams" colspan="2"><a class="anchor" id="a7bb78e24202b2c4c8ca181a842bae409"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:a7bb78e24202b2c4c8ca181a842bae409"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if&lt; std::is_array<br class="typebreak"/>
&lt; T &gt;::value, void &gt;::type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::load</b> (BinaryInputArchive &amp;ar, T &amp;array)</td></tr>
<tr class="memdesc:a7bb78e24202b2c4c8ca181a842bae409"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loading arrays. <br/></td></tr>
<tr class="separator:a7bb78e24202b2c4c8ca181a842bae409"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd8924b66686b003f01b5ceafa9d6ce1"><td class="memTemplParams" colspan="2"><a class="anchor" id="acd8924b66686b003f01b5ceafa9d6ce1"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:acd8924b66686b003f01b5ceafa9d6ce1"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::save</b> (BinaryOutputArchive &amp;ar, BinaryData&lt; T &gt; const &amp;bd)</td></tr>
<tr class="memdesc:acd8924b66686b003f01b5ceafa9d6ce1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saving binary data. <br/></td></tr>
<tr class="separator:acd8924b66686b003f01b5ceafa9d6ce1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae70a5689e08c0b5012651e2c7d4391ec"><td class="memTemplParams" colspan="2"><a class="anchor" id="ae70a5689e08c0b5012651e2c7d4391ec"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:ae70a5689e08c0b5012651e2c7d4391ec"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>cereal::load</b> (BinaryInputArchive &amp;ar, BinaryData&lt; T &gt; &amp;bd)</td></tr>
<tr class="memdesc:ae70a5689e08c0b5012651e2c7d4391ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loading binary data. <br/></td></tr>
<tr class="separator:ae70a5689e08c0b5012651e2c7d4391ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad91dc623e1a76680018a9dddfbc0fe03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad91dc623e1a76680018a9dddfbc0fe03"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>CEREAL_REGISTER_ARCHIVE</b> (<a class="el" href="classcereal_1_1BinaryOutputArchive.html">cereal::BinaryOutputArchive</a>)</td></tr>
<tr class="separator:ad91dc623e1a76680018a9dddfbc0fe03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a295db4ae35f5367b29923082de284419"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a295db4ae35f5367b29923082de284419"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>CEREAL_REGISTER_ARCHIVE</b> (<a class="el" href="classcereal_1_1BinaryInputArchive.html">cereal::BinaryInputArchive</a>)</td></tr>
<tr class="separator:a295db4ae35f5367b29923082de284419"><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></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 5 2013 20:54:19 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>