mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:12:01 +02:00
286 lines
26 KiB
HTML
286 lines
26 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::PortableBinaryInputArchive Class 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"><b>cereal</b></li><li class="navelem"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html">PortableBinaryInputArchive</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcereal_1_1PortableBinaryInputArchive-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::PortableBinaryInputArchive Class Reference<div class="ingroups"><a class="el" href="group__Archives.html">Input and Output Archive Types</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An input archive designed to load data saved using <a class="el" href="classcereal_1_1PortableBinaryOutputArchive.html" title="An output archive designed to save data in a compact binary representation portable over different ar...">PortableBinaryOutputArchive</a>.
|
|
<a href="classcereal_1_1PortableBinaryInputArchive.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="portable__binary_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/archives/portable_binary.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for cereal::PortableBinaryInputArchive:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classcereal_1_1PortableBinaryInputArchive.png" usemap="#cereal::PortableBinaryInputArchive_map" alt=""/>
|
|
<map id="cereal::PortableBinaryInputArchive_map" name="cereal::PortableBinaryInputArchive_map">
|
|
<area href="classcereal_1_1InputArchive.html" alt="cereal::InputArchive< PortableBinaryInputArchive, AllowEmptyClassElision >" shape="rect" coords="0,56,448,80"/>
|
|
<area href="classcereal_1_1detail_1_1InputArchiveBase.html" alt="cereal::detail::InputArchiveBase" shape="rect" coords="0,0,448,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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_1PortableBinaryInputArchive_1_1Options.html">Options</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class containing various advanced options for the PortableBinaryInput archive. <a href="classcereal_1_1PortableBinaryInputArchive_1_1Options.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="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4a6ae3ee7ee953859822ba98346e16b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html#a4a6ae3ee7ee953859822ba98346e16b5">PortableBinaryInputArchive</a> (std::istream &stream, <a class="el" href="classcereal_1_1PortableBinaryInputArchive_1_1Options.html">Options</a> const &options=<a class="el" href="classcereal_1_1PortableBinaryInputArchive_1_1Options.html#a965f5ff5784f38bbd080c30984bbd12a">Options::Default</a>())</td></tr>
|
|
<tr class="memdesc:a4a6ae3ee7ee953859822ba98346e16b5"><td class="mdescLeft"> </td><td class="mdescRight">Construct, loading from the provided stream. <a href="classcereal_1_1PortableBinaryInputArchive.html#a4a6ae3ee7ee953859822ba98346e16b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a6ae3ee7ee953859822ba98346e16b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4f71b625bb06db5fd0fec7b12a2cd97"><td class="memTemplParams" colspan="2">template<std::streamsize DataSize> </td></tr>
|
|
<tr class="memitem:ac4f71b625bb06db5fd0fec7b12a2cd97"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html#ac4f71b625bb06db5fd0fec7b12a2cd97">loadBinary</a> (void *const data, std::streamsize size)</td></tr>
|
|
<tr class="memdesc:ac4f71b625bb06db5fd0fec7b12a2cd97"><td class="mdescLeft"> </td><td class="mdescRight">Reads size bytes of data from the input stream. <a href="classcereal_1_1PortableBinaryInputArchive.html#ac4f71b625bb06db5fd0fec7b12a2cd97">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4f71b625bb06db5fd0fec7b12a2cd97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classcereal_1_1InputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1InputArchive')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive< PortableBinaryInputArchive, AllowEmptyClassElision ></a></td></tr>
|
|
<tr class="memitem:a76455fba49795d1676664f634918c580 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a76455fba49795d1676664f634918c580">InputArchive</a> (<a class="el" href="classcereal_1_1PortableBinaryInputArchive.html">PortableBinaryInputArchive</a> *const derived)</td></tr>
|
|
<tr class="memdesc:a76455fba49795d1676664f634918c580 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Construct the output archive. <a href="classcereal_1_1InputArchive.html#a76455fba49795d1676664f634918c580">More...</a><br /></td></tr>
|
|
<tr class="separator:a76455fba49795d1676664f634918c580 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1878bd30caccaf495bcb5062756559a4 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a id="a1878bd30caccaf495bcb5062756559a4"></a>
|
|
<a class="el" href="classcereal_1_1InputArchive.html">InputArchive</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1InputArchive.html">InputArchive</a> const &)=delete</td></tr>
|
|
<tr class="separator:a1878bd30caccaf495bcb5062756559a4 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21bf0587ab9749e2afde4bb51d8988ec inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html">PortableBinaryInputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a21bf0587ab9749e2afde4bb51d8988ec">operator()</a> (Types &&... args)</td></tr>
|
|
<tr class="memdesc:a21bf0587ab9749e2afde4bb51d8988ec inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes all passed in data. <a href="classcereal_1_1InputArchive.html#a21bf0587ab9749e2afde4bb51d8988ec">More...</a><br /></td></tr>
|
|
<tr class="separator:a21bf0587ab9749e2afde4bb51d8988ec inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a846b9482bf620966e2fa91921251a307 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a846b9482bf620966e2fa91921251a307">serializeDeferments</a> ()</td></tr>
|
|
<tr class="memdesc:a846b9482bf620966e2fa91921251a307 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes any data marked for deferment using defer. <a href="classcereal_1_1InputArchive.html#a846b9482bf620966e2fa91921251a307">More...</a><br /></td></tr>
|
|
<tr class="separator:a846b9482bf620966e2fa91921251a307 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a27251df805e938bd528dd680c2df5a47">getSharedPointer</a> (std::uint32_t const id)</td></tr>
|
|
<tr class="memdesc:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a shared pointer given a unique key for it. <a href="classcereal_1_1InputArchive.html#a27251df805e938bd528dd680c2df5a47">More...</a><br /></td></tr>
|
|
<tr class="separator:a27251df805e938bd528dd680c2df5a47 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a5a8c43c2803faa0b78cfb42e10c91d93">registerSharedPointer</a> (std::uint32_t const id, std::shared_ptr< void > ptr)</td></tr>
|
|
<tr class="memdesc:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a shared pointer to its unique identifier. <a href="classcereal_1_1InputArchive.html#a5a8c43c2803faa0b78cfb42e10c91d93">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a8c43c2803faa0b78cfb42e10c91d93 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a2d39247b893f26eecc863a7b321e6a00">getPolymorphicName</a> (std::uint32_t const id)</td></tr>
|
|
<tr class="memdesc:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the string for a polymorphic type given a unique key for it. <a href="classcereal_1_1InputArchive.html#a2d39247b893f26eecc863a7b321e6a00">More...</a><br /></td></tr>
|
|
<tr class="separator:a2d39247b893f26eecc863a7b321e6a00 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#ae6602c484b49376ad1c392719d02ef56">registerPolymorphicName</a> (std::uint32_t const id, std::string const &name)</td></tr>
|
|
<tr class="memdesc:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a polymorphic name string to its unique identifier. <a href="classcereal_1_1InputArchive.html#ae6602c484b49376ad1c392719d02ef56">More...</a><br /></td></tr>
|
|
<tr class="separator:ae6602c484b49376ad1c392719d02ef56 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88c7141a24a934978b1ef9894215e67f inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html">PortableBinaryInputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#a88c7141a24a934978b1ef9894215e67f">operator&</a> (T &&arg)</td></tr>
|
|
<tr class="memdesc:a88c7141a24a934978b1ef9894215e67f inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1InputArchive.html#a88c7141a24a934978b1ef9894215e67f">More...</a><br /></td></tr>
|
|
<tr class="separator:a88c7141a24a934978b1ef9894215e67f inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe460125bb5603ae92517d21d2733491 inherit pub_methods_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1PortableBinaryInputArchive.html">PortableBinaryInputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#abe460125bb5603ae92517d21d2733491">operator>></a> (T &&arg)</td></tr>
|
|
<tr class="memdesc:abe460125bb5603ae92517d21d2733491 inherit pub_methods_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1InputArchive.html#abe460125bb5603ae92517d21d2733491">More...</a><br /></td></tr>
|
|
<tr class="separator:abe460125bb5603ae92517d21d2733491 inherit pub_methods_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1detail_1_1InputArchiveBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">cereal::detail::InputArchiveBase</a></td></tr>
|
|
<tr class="memitem:a6c3165c8d75cc83037a6f25c5d3bf3d4 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a6c3165c8d75cc83037a6f25c5d3bf3d4"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>InputArchiveBase</b> (<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> &&) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
|
|
<tr class="separator:a6c3165c8d75cc83037a6f25c5d3bf3d4 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b543080f3f5717657f36cee95450357 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a7b543080f3f5717657f36cee95450357"></a>
|
|
<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1detail_1_1InputArchiveBase.html">InputArchiveBase</a> &&) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
|
|
<tr class="separator:a7b543080f3f5717657f36cee95450357 inherit pub_methods_classcereal_1_1detail_1_1InputArchiveBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classcereal_1_1InputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classcereal_1_1InputArchive')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classcereal_1_1InputArchive.html">cereal::InputArchive< PortableBinaryInputArchive, AllowEmptyClassElision ></a></td></tr>
|
|
<tr class="memitem:adeb555e9b25f21391e4cc9eca9f04dbd inherit pub_types_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#adeb555e9b25f21391e4cc9eca9f04dbd">is_loading</a> = std::true_type</td></tr>
|
|
<tr class="memdesc:adeb555e9b25f21391e4cc9eca9f04dbd inherit pub_types_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Indicates this archive is intended for loading. <a href="classcereal_1_1InputArchive.html#adeb555e9b25f21391e4cc9eca9f04dbd">More...</a><br /></td></tr>
|
|
<tr class="separator:adeb555e9b25f21391e4cc9eca9f04dbd inherit pub_types_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af90a8d1dc2c9163367765817f7b704d4 inherit pub_types_classcereal_1_1InputArchive"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1InputArchive.html#af90a8d1dc2c9163367765817f7b704d4">is_saving</a> = std::false_type</td></tr>
|
|
<tr class="memdesc:af90a8d1dc2c9163367765817f7b704d4 inherit pub_types_classcereal_1_1InputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Indicates this archive is not intended for saving. <a href="classcereal_1_1InputArchive.html#af90a8d1dc2c9163367765817f7b704d4">More...</a><br /></td></tr>
|
|
<tr class="separator:af90a8d1dc2c9163367765817f7b704d4 inherit pub_types_classcereal_1_1InputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An input archive designed to load data saved using <a class="el" href="classcereal_1_1PortableBinaryOutputArchive.html" title="An output archive designed to save data in a compact binary representation portable over different ar...">PortableBinaryOutputArchive</a>. </p>
|
|
<p>This archive outputs data to a stream in an extremely compact binary representation with as little extra metadata as possible.</p>
|
|
<p>This archive will load the endianness of the serialized data and if necessary transform it to match that of the local machine. This comes at a significant performance cost compared to non portable archives if the transformation is necessary, and also causes a small performance hit even if it is not necessary.</p>
|
|
<p>It is recommended to use portable archives only if you know that you will be sending binary data to machines with different endianness.</p>
|
|
<p>The archive will do nothing to ensure types are the same size - that is the responsibility of the user.</p>
|
|
<p>When using a binary archive and a file stream, you must use the std::ios::binary format flag to avoid having your data altered inadvertently.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This archive has not been thoroughly tested across different architectures. Please report any issues, optimizations, or feature requests at <a href="www.github.com/USCiLab/cereal">the project github</a>. </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a4a6ae3ee7ee953859822ba98346e16b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a6ae3ee7ee953859822ba98346e16b5">◆ </a></span>PortableBinaryInputArchive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cereal::PortableBinaryInputArchive::PortableBinaryInputArchive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::istream & </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classcereal_1_1PortableBinaryInputArchive_1_1Options.html">Options</a> const & </td>
|
|
<td class="paramname"><em>options</em> = <code><a class="el" href="classcereal_1_1PortableBinaryInputArchive_1_1Options.html#a965f5ff5784f38bbd080c30984bbd12a">Options::Default</a>()</code> </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>Construct, loading from the provided stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>The stream to read from. Should be opened with std::ios::binary flag. </td></tr>
|
|
<tr><td class="paramname">options</td><td>The PortableBinary specific options to use. See the <a class="el" href="classcereal_1_1PortableBinaryInputArchive_1_1Options.html" title="A class containing various advanced options for the PortableBinaryInput archive.">Options</a> struct for the values of default parameters </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac4f71b625bb06db5fd0fec7b12a2cd97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4f71b625bb06db5fd0fec7b12a2cd97">◆ </a></span>loadBinary()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<std::streamsize DataSize> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void cereal::PortableBinaryInputArchive::loadBinary </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void *const </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::streamsize </td>
|
|
<td class="paramname"><em>size</em> </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>Reads size bytes of data from the input stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>The data to save </td></tr>
|
|
<tr><td class="paramname">size</td><td>The number of bytes in the data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">DataSize</td><td>T The size of the actual type of the data elements being loaded </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="portable__binary_8hpp_source.html">portable_binary.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  <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>
|