185 lines
13 KiB
HTML
185 lines
13 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: 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/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 Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </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"><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">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="structcereal_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="#ac1e4544b74594d2752e8a41ea5992f16">More...</a><br/></td></tr>
|
|
<tr class="separator:ac1e4544b74594d2752e8a41ea5992f16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08fa92f2dc0c2de937afc10edd2c51b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08fa92f2dc0c2de937afc10edd2c51b2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1BinaryOutputArchive.html#a08fa92f2dc0c2de937afc10edd2c51b2">saveBinary</a> (const void *data, size_t size)</td></tr>
|
|
<tr class="memdesc:a08fa92f2dc0c2de937afc10edd2c51b2"><td class="mdescLeft"> </td><td class="mdescRight">Writes size bytes of data to the output stream. <br/></td></tr>
|
|
<tr class="separator:a08fa92f2dc0c2de937afc10edd2c51b2"><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:ad68d8620b5fb99619f6ef37be29356eb 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#ad68d8620b5fb99619f6ef37be29356eb">OutputArchive</a> (<a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> *const self)</td></tr>
|
|
<tr class="memdesc:ad68d8620b5fb99619f6ef37be29356eb inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Construct the output archive. <a href="#ad68d8620b5fb99619f6ef37be29356eb">More...</a><br/></td></tr>
|
|
<tr class="separator:ad68d8620b5fb99619f6ef37be29356eb inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48a65660f32a2b90f7ab26ebba25707c inherit pub_methods_classcereal_1_1OutputArchive"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48a65660f32a2b90f7ab26ebba25707c"></a>
|
|
<a class="el" href="classcereal_1_1BinaryOutputArchive.html">BinaryOutputArchive</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1OutputArchive.html#a48a65660f32a2b90f7ab26ebba25707c">operator()</a> (Types &&...args)</td></tr>
|
|
<tr class="memdesc:a48a65660f32a2b90f7ab26ebba25707c inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Serializes all passed in data. <br/></td></tr>
|
|
<tr class="separator:a48a65660f32a2b90f7ab26ebba25707c inherit pub_methods_classcereal_1_1OutputArchive"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3ea2da529d82dd84c49c3a56ff91846 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#ac3ea2da529d82dd84c49c3a56ff91846">registerSharedPointer</a> (void const *addr)</td></tr>
|
|
<tr class="memdesc:ac3ea2da529d82dd84c49c3a56ff91846 inherit pub_methods_classcereal_1_1OutputArchive"><td class="mdescLeft"> </td><td class="mdescRight">Registers a shared pointer with the archive. <a href="#ac3ea2da529d82dd84c49c3a56ff91846">More...</a><br/></td></tr>
|
|
<tr class="separator:ac3ea2da529d82dd84c49c3a56ff91846 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="#abf97e7c48f6d307d6fa87d4b3fd3ad0e">More...</a><br/></td></tr>
|
|
<tr class="separator:abf97e7c48f6d307d6fa87d4b3fd3ad0e inherit pub_methods_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>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ac1e4544b74594d2752e8a41ea5992f16"></a>
|
|
<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>include/cereal/archives/<a class="el" href="binary_8hpp_source.html">binary.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jul 5 2013 20:54:19 for cereal by  <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>
|