mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:22:01 +02:00
178 lines
11 KiB
HTML
178 lines
11 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::PortableBinaryOutputArchive::Options 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_1PortableBinaryOutputArchive.html">PortableBinaryOutputArchive</a></li><li class="navelem"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html">Options</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classcereal_1_1PortableBinaryOutputArchive_1_1Options-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::PortableBinaryOutputArchive::Options Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A class containing various advanced options for the PortableBinaryOutput archive.
|
|
<a href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.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>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ae2a21b6c39ca3520f070c8484c40f534"><td class="memItemLeft" align="right" valign="top"><a id="ae2a21b6c39ca3520f070c8484c40f534"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#ae2a21b6c39ca3520f070c8484c40f534">Endianness</a> : std::uint8_t { <b>big</b>,
|
|
<b>little</b>
|
|
}</td></tr>
|
|
<tr class="memdesc:ae2a21b6c39ca3520f070c8484c40f534"><td class="mdescLeft"> </td><td class="mdescRight">Represents desired endianness. <br /></td></tr>
|
|
<tr class="separator:ae2a21b6c39ca3520f070c8484c40f534"><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:a4d1a04340ee609126fa20e25397e1e9f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#a4d1a04340ee609126fa20e25397e1e9f">Options</a> (<a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#ae2a21b6c39ca3520f070c8484c40f534">Endianness</a> outputEndian=getEndianness())</td></tr>
|
|
<tr class="memdesc:a4d1a04340ee609126fa20e25397e1e9f"><td class="mdescLeft"> </td><td class="mdescRight">Specify specific options for the <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_1PortableBinaryOutputArchive_1_1Options.html#a4d1a04340ee609126fa20e25397e1e9f">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d1a04340ee609126fa20e25397e1e9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a98642199679b45167f773b9c6f4f3ac2"><td class="memItemLeft" align="right" valign="top"><a id="a98642199679b45167f773b9c6f4f3ac2"></a>
|
|
static <a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html">Options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#a98642199679b45167f773b9c6f4f3ac2">Default</a> ()</td></tr>
|
|
<tr class="memdesc:a98642199679b45167f773b9c6f4f3ac2"><td class="mdescLeft"> </td><td class="mdescRight">Default options, preserve system endianness. <br /></td></tr>
|
|
<tr class="separator:a98642199679b45167f773b9c6f4f3ac2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ad926cd9e8e50f5795807ec14cc0e8e"><td class="memItemLeft" align="right" valign="top"><a id="a7ad926cd9e8e50f5795807ec14cc0e8e"></a>
|
|
static <a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html">Options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#a7ad926cd9e8e50f5795807ec14cc0e8e">LittleEndian</a> ()</td></tr>
|
|
<tr class="memdesc:a7ad926cd9e8e50f5795807ec14cc0e8e"><td class="mdescLeft"> </td><td class="mdescRight">Save as little endian. <br /></td></tr>
|
|
<tr class="separator:a7ad926cd9e8e50f5795807ec14cc0e8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16c01f4198a9d3b2df4f0b1c29582fa6"><td class="memItemLeft" align="right" valign="top"><a id="a16c01f4198a9d3b2df4f0b1c29582fa6"></a>
|
|
static <a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html">Options</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#a16c01f4198a9d3b2df4f0b1c29582fa6">BigEndian</a> ()</td></tr>
|
|
<tr class="memdesc:a16c01f4198a9d3b2df4f0b1c29582fa6"><td class="mdescLeft"> </td><td class="mdescRight">Save as big endian. <br /></td></tr>
|
|
<tr class="separator:a16c01f4198a9d3b2df4f0b1c29582fa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a861ac8d5a96a2a4ffc640593822459ec"><td class="memItemLeft" align="right" valign="top"><a id="a861ac8d5a96a2a4ffc640593822459ec"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>PortableBinaryOutputArchive</b></td></tr>
|
|
<tr class="separator:a861ac8d5a96a2a4ffc640593822459ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A class containing various advanced options for the PortableBinaryOutput archive. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a4d1a04340ee609126fa20e25397e1e9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d1a04340ee609126fa20e25397e1e9f">◆ </a></span>Options()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">cereal::PortableBinaryOutputArchive::Options::Options </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classcereal_1_1PortableBinaryOutputArchive_1_1Options.html#ae2a21b6c39ca3520f070c8484c40f534">Endianness</a> </td>
|
|
<td class="paramname"><em>outputEndian</em> = <code>getEndianness()</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Specify specific options for the <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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">outputEndian</td><td>The desired endianness of saved (output) data </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>
|