218 lines
12 KiB
HTML
218 lines
12 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::BinaryData< T > Struct Template 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="structcereal_1_1BinaryData.html">BinaryData</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-attribs">Public Attributes</a> |
|
|
<a href="#related">Related Functions</a> |
|
|
<a href="structcereal_1_1BinaryData-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::BinaryData< T > Struct Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A wrapper around data that can be serialized in a binary fashion.
|
|
<a href="structcereal_1_1BinaryData.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="helpers_8hpp_source.html">cereal/details/helpers.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:a5da7601825183538439d32e77436af88"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1BinaryData.html#a5da7601825183538439d32e77436af88">PT</a> = typename std::conditional< std::is_const< typename std::remove_pointer< T >::type >::value, const void *, void * >::type</td></tr>
|
|
<tr class="separator:a5da7601825183538439d32e77436af88"><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:a08d9ac1b5fe0d01ff61e520ec974293a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08d9ac1b5fe0d01ff61e520ec974293a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BinaryData</b> (T &&d, uint64_t s)</td></tr>
|
|
<tr class="separator:a08d9ac1b5fe0d01ff61e520ec974293a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0bac12b9a4e870dfb89a73d6731f9109"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bac12b9a4e870dfb89a73d6731f9109"></a>
|
|
<a class="el" href="structcereal_1_1BinaryData.html#a5da7601825183538439d32e77436af88">PT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1BinaryData.html#a0bac12b9a4e870dfb89a73d6731f9109">data</a></td></tr>
|
|
<tr class="memdesc:a0bac12b9a4e870dfb89a73d6731f9109"><td class="mdescLeft"> </td><td class="mdescRight">pointer to beginning of data <br/></td></tr>
|
|
<tr class="separator:a0bac12b9a4e870dfb89a73d6731f9109"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c5b15fee4187ac9d948081a3ea9cfe3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c5b15fee4187ac9d948081a3ea9cfe3"></a>
|
|
uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1BinaryData.html#a6c5b15fee4187ac9d948081a3ea9cfe3">size</a></td></tr>
|
|
<tr class="memdesc:a6c5b15fee4187ac9d948081a3ea9cfe3"><td class="mdescLeft"> </td><td class="mdescRight">size in bytes <br/></td></tr>
|
|
<tr class="separator:a6c5b15fee4187ac9d948081a3ea9cfe3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
|
|
Related Functions</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
|
|
</td></tr>
|
|
<tr class="memitem:a593d161603775672f91ab448ef65083e"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a593d161603775672f91ab448ef65083e"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcereal_1_1BinaryData.html">BinaryData</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structcereal_1_1BinaryData.html#a593d161603775672f91ab448ef65083e">binary_data</a> (T &&<a class="el" href="structcereal_1_1BinaryData.html#a0bac12b9a4e870dfb89a73d6731f9109">data</a>, size_t <a class="el" href="structcereal_1_1BinaryData.html#a6c5b15fee4187ac9d948081a3ea9cfe3">size</a>)</td></tr>
|
|
<tr class="memdesc:a593d161603775672f91ab448ef65083e"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to create binary data for both const and non const pointers. <a href="#a593d161603775672f91ab448ef65083e">More...</a><br/></td></tr>
|
|
<tr class="separator:a593d161603775672f91ab448ef65083e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<class T><br/>
|
|
struct cereal::BinaryData< T ></h3>
|
|
|
|
<p>A wrapper around data that can be serialized in a binary fashion. </p>
|
|
<p>This class is used to demarcate data that can safely be serialized as a binary chunk of data. Individual archives can then choose how best represent this during serialization. </p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a class="anchor" id="a5da7601825183538439d32e77436af88"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="structcereal_1_1BinaryData.html">cereal::BinaryData</a>< T >::<a class="el" href="structcereal_1_1BinaryData.html#a5da7601825183538439d32e77436af88">PT</a> = typename std::conditional<std::is_const<typename std::remove_pointer<T>::type>::value, const void *, void *>::type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Internally store the pointer as a void *, keeping const if created with a const pointer </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a class="anchor" id="a593d161603775672f91ab448ef65083e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structcereal_1_1BinaryData.html">BinaryData</a>< T > binary_data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T && </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </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">related</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convenience function to create binary data for both const and non const pointers. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to beginning of the data </td></tr>
|
|
<tr><td class="paramname">size</td><td>The size in bytes of the data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>include/cereal/details/<a class="el" href="helpers_8hpp_source.html">helpers.hpp</a></li>
|
|
<li>include/cereal/<a class="el" href="cereal_8hpp_source.html">cereal.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Jul 5 2013 20:54:20 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>
|