mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:12:01 +02:00
205 lines
19 KiB
HTML
205 lines
19 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::BinaryOutputArchive 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_1BinaryOutputArchive.html">BinaryOutputArchive</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcereal_1_1BinaryOutputArchive-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::BinaryOutputArchive 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 output archive designed to save data in a compact binary representation.
|
|
<a href="classcereal_1_1BinaryOutputArchive.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="binary_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/archives/binary.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for cereal::BinaryOutputArchive:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classcereal_1_1BinaryOutputArchive.png" usemap="#cereal::BinaryOutputArchive_map" alt=""/>
|
|
<map id="cereal::BinaryOutputArchive_map" name="cereal::BinaryOutputArchive_map">
|
|
<area href="classcereal_1_1OutputArchive.html" alt="cereal::OutputArchive< BinaryOutputArchive, AllowEmptyClassElision >" shape="rect" coords="0,56,421,80"/>
|
|
<area href="classcereal_1_1detail_1_1OutputArchiveBase.html" alt="cereal::detail::OutputArchiveBase" shape="rect" coords="0,0,421,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:ac1e4544b74594d2752e8a41ea5992f16"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryOutputArchive.html#ac1e4544b74594d2752e8a41ea5992f16">BinaryOutputArchive</a> (std::ostream &stream)</td></tr>
|
|
<tr class="memdesc:ac1e4544b74594d2752e8a41ea5992f16"><td class="mdescLeft"> </td><td class="mdescRight">Construct, outputting to the provided stream. <a href="classcereal_1_1BinaryOutputArchive.html#ac1e4544b74594d2752e8a41ea5992f16">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1e4544b74594d2752e8a41ea5992f16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad80ca965dd00c99a9578d7df763006a7"><td class="memItemLeft" align="right" valign="top"><a id="ad80ca965dd00c99a9578d7df763006a7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryOutputArchive.html#ad80ca965dd00c99a9578d7df763006a7">saveBinary</a> (const void *data, std::streamsize size)</td></tr>
|
|
<tr class="memdesc:ad80ca965dd00c99a9578d7df763006a7"><td class="mdescLeft"> </td><td class="mdescRight">Writes size bytes of data to the output stream. <br /></td></tr>
|
|
<tr class="separator:ad80ca965dd00c99a9578d7df763006a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classcereal_1_1OutputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1OutputArchive')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcereal_1_1OutputArchive.html">cereal::OutputArchive< BinaryOutputArchive, AllowEmptyClassElision ></a></td></tr>
|
|
<tr class="memitem:a98fbde73bf6d41f4e717e91011e3be7f inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a98fbde73bf6d41f4e717e91011e3be7f">OutputArchive</a> (<a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> *const derived)</td></tr>
|
|
<tr class="memdesc:a98fbde73bf6d41f4e717e91011e3be7f inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Construct the output archive. <a href="classcereal_1_1OutputArchive.html#a98fbde73bf6d41f4e717e91011e3be7f">More...</a><br /></td></tr>
|
|
<tr class="separator:a98fbde73bf6d41f4e717e91011e3be7f inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c6421d26bc4d2cd95db038c3ce91a49 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"><a id="a2c6421d26bc4d2cd95db038c3ce91a49"></a>
|
|
<a class="el" href="classcereal_1_1OutputArchive.html">OutputArchive</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1OutputArchive.html">OutputArchive</a> const &)=delete</td></tr>
|
|
<tr class="separator:a2c6421d26bc4d2cd95db038c3ce91a49 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abef67f45c79d199c690359715905987b inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#abef67f45c79d199c690359715905987b">operator()</a> (Types &&... args)</td></tr>
|
|
<tr class="memdesc:abef67f45c79d199c690359715905987b inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes all passed in data. <a href="classcereal_1_1OutputArchive.html#abef67f45c79d199c690359715905987b">More...</a><br /></td></tr>
|
|
<tr class="separator:abef67f45c79d199c690359715905987b inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0070bbf21d6a02a48d55b8052b90f64 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#ac0070bbf21d6a02a48d55b8052b90f64">serializeDeferments</a> ()</td></tr>
|
|
<tr class="memdesc:ac0070bbf21d6a02a48d55b8052b90f64 inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes any data marked for deferment using defer. <a href="classcereal_1_1OutputArchive.html#ac0070bbf21d6a02a48d55b8052b90f64">More...</a><br /></td></tr>
|
|
<tr class="separator:ac0070bbf21d6a02a48d55b8052b90f64 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0efb18ad82f46327f48449e84222328b inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top">std::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a0efb18ad82f46327f48449e84222328b">registerSharedPointer</a> (const std::shared_ptr< const void > &sharedPointer)</td></tr>
|
|
<tr class="memdesc:a0efb18ad82f46327f48449e84222328b inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a shared pointer with the archive. <a href="classcereal_1_1OutputArchive.html#a0efb18ad82f46327f48449e84222328b">More...</a><br /></td></tr>
|
|
<tr class="separator:a0efb18ad82f46327f48449e84222328b inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf97e7c48f6d307d6fa87d4b3fd3ad0e inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top">std::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#abf97e7c48f6d307d6fa87d4b3fd3ad0e">registerPolymorphicType</a> (char const *name)</td></tr>
|
|
<tr class="memdesc:abf97e7c48f6d307d6fa87d4b3fd3ad0e inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a polymorphic type name with the archive. <a href="classcereal_1_1OutputArchive.html#abf97e7c48f6d307d6fa87d4b3fd3ad0e">More...</a><br /></td></tr>
|
|
<tr class="separator:abf97e7c48f6d307d6fa87d4b3fd3ad0e inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4788dde3f0691f0dbbfc14fe6e2997cd inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a4788dde3f0691f0dbbfc14fe6e2997cd">operator&</a> (T &&arg)</td></tr>
|
|
<tr class="memdesc:a4788dde3f0691f0dbbfc14fe6e2997cd inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1OutputArchive.html#a4788dde3f0691f0dbbfc14fe6e2997cd">More...</a><br /></td></tr>
|
|
<tr class="separator:a4788dde3f0691f0dbbfc14fe6e2997cd inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0316f5791b140979aea2c915e4618236 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a0316f5791b140979aea2c915e4618236">operator<<</a> (T &&arg)</td></tr>
|
|
<tr class="memdesc:a0316f5791b140979aea2c915e4618236 inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes passed in data. <a href="classcereal_1_1OutputArchive.html#a0316f5791b140979aea2c915e4618236">More...</a><br /></td></tr>
|
|
<tr class="separator:a0316f5791b140979aea2c915e4618236 inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcereal_1_1detail_1_1OutputArchiveBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">cereal::detail::OutputArchiveBase</a></td></tr>
|
|
<tr class="memitem:a4cbe03d4e35e298aaab32eaf117021be inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="a4cbe03d4e35e298aaab32eaf117021be"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>OutputArchiveBase</b> (<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> &&) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
|
|
<tr class="separator:a4cbe03d4e35e298aaab32eaf117021be inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd5f88c3cc3ef044eea98df20b1f01db inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><td class="memItemLeft" align="right" valign="top"><a id="afd5f88c3cc3ef044eea98df20b1f01db"></a>
|
|
<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcereal_1_1detail_1_1OutputArchiveBase.html">OutputArchiveBase</a> &&) <a class="el" href="macros_8hpp.html#a6c37b2307b83bbe2a3de58d78a2b8c0b">CEREAL_NOEXCEPT</a></td></tr>
|
|
<tr class="separator:afd5f88c3cc3ef044eea98df20b1f01db inherit pub_methods_classcereal_1_1detail_1_1OutputArchiveBase"><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_1OutputArchive"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classcereal_1_1OutputArchive')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classcereal_1_1OutputArchive.html">cereal::OutputArchive< BinaryOutputArchive, AllowEmptyClassElision ></a></td></tr>
|
|
<tr class="memitem:a8f3be4fe8a965bbce4eb1cf36068e611 inherit pub_types_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a8f3be4fe8a965bbce4eb1cf36068e611">is_loading</a> = std::false_type</td></tr>
|
|
<tr class="memdesc:a8f3be4fe8a965bbce4eb1cf36068e611 inherit pub_types_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Indicates this archive is not intended for loading. <a href="classcereal_1_1OutputArchive.html#a8f3be4fe8a965bbce4eb1cf36068e611">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f3be4fe8a965bbce4eb1cf36068e611 inherit pub_types_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad48175118ea9b931ef42a74f8efd0389 inherit pub_types_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#ad48175118ea9b931ef42a74f8efd0389">is_saving</a> = std::true_type</td></tr>
|
|
<tr class="memdesc:ad48175118ea9b931ef42a74f8efd0389 inherit pub_types_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Indicates this archive is intended for saving. <a href="classcereal_1_1OutputArchive.html#ad48175118ea9b931ef42a74f8efd0389">More...</a><br /></td></tr>
|
|
<tr class="separator:ad48175118ea9b931ef42a74f8efd0389 inherit pub_types_classcereal_1_1OutputArchive"><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 output archive designed to save data in a compact binary representation. </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 does nothing to ensure that the endianness of the saved and loaded data is the same. If you need to have portability over architectures with different endianness, use <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>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>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ac1e4544b74594d2752e8a41ea5992f16"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1e4544b74594d2752e8a41ea5992f16">◆ </a></span>BinaryOutputArchive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cereal::BinaryOutputArchive::BinaryOutputArchive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream & </td>
|
|
<td class="paramname"><em>stream</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>Construct, outputting to the provided stream. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>The stream to output to. Can be a stringstream, a file stream, or even cout! </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="binary_8hpp_source.html">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>
|