mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:12:01 +02:00
162 lines
9.6 KiB
HTML
162 lines
9.6 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::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/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="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">/home/shane/workspace/cereal/include/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:a468ac8aa627810ef85d501b017c5467f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1BinaryData.html#a468ac8aa627810ef85d501b017c5467f">PT</a> = typename std::conditional< std::is_const< typename std::remove_pointer< typename std::remove_reference< T >::type >::type >::value, const void *, void * >::type</td></tr>
|
|
<tr class="separator:a468ac8aa627810ef85d501b017c5467f"><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 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 id="a0bac12b9a4e870dfb89a73d6731f9109"></a>
|
|
<a class="el" href="structcereal_1_1BinaryData.html#a468ac8aa627810ef85d501b017c5467f">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 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:ga593d161603775672f91ab448ef65083e"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:ga593d161603775672f91ab448ef65083e"><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="group__Utility.html#ga593d161603775672f91ab448ef65083e">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:ga593d161603775672f91ab448ef65083e"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to create binary data for both const and non const pointers. <a href="group__Utility.html#ga593d161603775672f91ab448ef65083e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga593d161603775672f91ab448ef65083e"><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 id="a468ac8aa627810ef85d501b017c5467f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a468ac8aa627810ef85d501b017c5467f">◆ </a></span>PT</h2>
|
|
|
|
<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#a468ac8aa627810ef85d501b017c5467f">PT</a> = typename std::conditional<std::is_const<typename std::remove_pointer<typename std::remove_reference<T>::type>::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>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li><a class="el" href="helpers_8hpp_source.html">helpers.hpp</a></li>
|
|
<li><a class="el" href="cereal_8hpp_source.html">cereal.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>
|