mirror of
https://github.com/USCiLab/cereal.git
synced 2025-07-21 02:22:01 +02:00
155 lines
10 KiB
HTML
155 lines
10 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::MapItem< Key, Value > 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_1MapItem.html">MapItem</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="structcereal_1_1MapItem-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">cereal::MapItem< Key, Value > Struct Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A wrapper around a key and value for serializing data into maps.
|
|
<a href="structcereal_1_1MapItem.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:a725a4a2d5fe60c37e90cebb7e4a7fe30"><td class="memItemLeft" align="right" valign="top"><a id="a725a4a2d5fe60c37e90cebb7e4a7fe30"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>KeyType</b> = typename std::conditional< std::is_lvalue_reference< Key >::value, Key, typename std::decay< Key >::type >::type</td></tr>
|
|
<tr class="separator:a725a4a2d5fe60c37e90cebb7e4a7fe30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a788423f5877112816610d168f18e968c"><td class="memItemLeft" align="right" valign="top"><a id="a788423f5877112816610d168f18e968c"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>ValueType</b> = typename std::conditional< std::is_lvalue_reference< Value >::value, Value, typename std::decay< Value >::type >::type</td></tr>
|
|
<tr class="separator:a788423f5877112816610d168f18e968c"><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:a4f348c6c831ee140b28c2fda7f1075cb"><td class="memItemLeft" align="right" valign="top"><a id="a4f348c6c831ee140b28c2fda7f1075cb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structcereal_1_1MapItem.html#a4f348c6c831ee140b28c2fda7f1075cb">MapItem</a> (Key &&key_, Value &&value_)</td></tr>
|
|
<tr class="memdesc:a4f348c6c831ee140b28c2fda7f1075cb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="structcereal_1_1MapItem.html" title="A wrapper around a key and value for serializing data into maps.">MapItem</a> from a key and a value. <br /></td></tr>
|
|
<tr class="separator:a4f348c6c831ee140b28c2fda7f1075cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a986dc92e8472a916f7f92b22c119d5f6"><td class="memItemLeft" align="right" valign="top"><a id="a986dc92e8472a916f7f92b22c119d5f6"></a>
|
|
<a class="el" href="structcereal_1_1MapItem.html">MapItem</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="structcereal_1_1MapItem.html">MapItem</a> const &)=delete</td></tr>
|
|
<tr class="separator:a986dc92e8472a916f7f92b22c119d5f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabc18ae871506e4965cd785ad314e1ec"><td class="memTemplParams" colspan="2"><a id="aabc18ae871506e4965cd785ad314e1ec"></a>
|
|
template<class Archive > </td></tr>
|
|
<tr class="memitem:aabc18ae871506e4965cd785ad314e1ec"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structcereal_1_1MapItem.html#aabc18ae871506e4965cd785ad314e1ec">CEREAL_SERIALIZE_FUNCTION_NAME</a> (Archive &archive)</td></tr>
|
|
<tr class="memdesc:aabc18ae871506e4965cd785ad314e1ec"><td class="mdescLeft"> </td><td class="mdescRight">Serialize the <a class="el" href="structcereal_1_1MapItem.html" title="A wrapper around a key and value for serializing data into maps.">MapItem</a> with the NVPs "key" and "value". <br /></td></tr>
|
|
<tr class="separator:aabc18ae871506e4965cd785ad314e1ec"><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:af4d4e11ae4f201877bc57952becf2eef"><td class="memItemLeft" align="right" valign="top"><a id="af4d4e11ae4f201877bc57952becf2eef"></a>
|
|
KeyType </td><td class="memItemRight" valign="bottom"><b>key</b></td></tr>
|
|
<tr class="separator:af4d4e11ae4f201877bc57952becf2eef"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afba0b9518e84a845eb2b6f1f74cf3f56"><td class="memItemLeft" align="right" valign="top"><a id="afba0b9518e84a845eb2b6f1f74cf3f56"></a>
|
|
ValueType </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
|
|
<tr class="separator:afba0b9518e84a845eb2b6f1f74cf3f56"><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 Key, class Value><br />
|
|
struct cereal::MapItem< Key, Value ></h3>
|
|
|
|
<p>A wrapper around a key and value for serializing data into maps. </p>
|
|
<p>This class just provides a grouping of keys and values into a struct for human readable archives. For example, XML archives will use this wrapper to write maps like so:</p>
|
|
<div class="fragment"><div class="line"><<span class="keywordtype">mymap</span>></div>
|
|
<div class="line"> <<span class="keywordtype">item0</span>></div>
|
|
<div class="line"> <<span class="keywordtype">key</span>><span class="keyword">MyFirstKey</span></<span class="keywordtype">key</span>></div>
|
|
<div class="line"> <<span class="keywordtype">value</span>><span class="keyword">MyFirstValue</span></<span class="keywordtype">value</span>></div>
|
|
<div class="line"> </<span class="keywordtype">item0</span>></div>
|
|
<div class="line"> <<span class="keywordtype">item1</span>></div>
|
|
<div class="line"> <<span class="keywordtype">key</span>><span class="keyword">MySecondKey</span></<span class="keywordtype">key</span>></div>
|
|
<div class="line"> <<span class="keywordtype">value</span>><span class="keyword">MySecondValue</span></<span class="keywordtype">value</span>></div>
|
|
<div class="line"> </<span class="keywordtype">item1</span>></div>
|
|
<div class="line"></<span class="keywordtype">mymap</span>></div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd>make_map_item </dd></dl>
|
|
</div><hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="helpers_8hpp_source.html">helpers.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>
|