mirror of
https://github.com/msgpack/msgpack-c.git
synced 2025-04-19 15:47:15 +02:00
152 lines
18 KiB
HTML
152 lines
18 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MessagePack for C++: msgpack/v3/x3_unpack_decl.hpp Source File</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">MessagePack for C++
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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','.html');
|
|
/* @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"><a class="el" href="dir_34fe0060e19d01bea8daf072c0f69c00.html">msgpack</a></li><li class="navelem"><a class="el" href="dir_c3d0e5868165b982fb6c11f3b1a5ff9d.html">v3</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">x3_unpack_decl.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="v3_2x3__unpack__decl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// MessagePack for C++ deserializing routine</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2017 KONDO Takatoshi</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// Distributed under the Boost Software License, Version 1.0.</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (See accompanying file LICENSE_1_0.txt or copy at</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// http://www.boost.org/LICENSE_1_0.txt)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef MSGPACK_V3_X3_UNPACK_DECL_HPP</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define MSGPACK_V3_X3_UNPACK_DECL_HPP</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#if defined(MSGPACK_USE_X3_PARSE)</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "<a class="code" href="v2_2x3__unpack__decl_8hpp.html">msgpack/v2/x3_unpack_decl.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespacemsgpack.html">msgpack</a> {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <a class="code" href="v1_2versioning_8hpp.html#afc7672e6f1fe2324a37d578e787408b8">MSGPACK_API_VERSION_NAMESPACE</a>(v3) {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>detail {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">using</span> <a class="code" href="namespacemsgpack_1_1detail.html#a53b09020df222a85f50b415c705833c9">v2::detail::unpack_imp</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> } <span class="comment">// detail</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <a class="code" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> <a class="code" href="namespacemsgpack.html#af8c675c74116393a0b90e4dc64d18a0d">unpack</a>(</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  Iterator&& <a class="code" href="namespacemsgpack.html#ad52c02be11a42c58799707aa0b71ca4e">begin</a>, Iterator&& <a class="code" href="namespacemsgpack.html#a9426a4160106ee0a2574c731656ea9ac">end</a>,</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span>& referenced,</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a> f = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, <span class="keywordtype">void</span>* user_data = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>,</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  unpack_limit <span class="keyword">const</span>& limit = unpack_limit());</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <a class="code" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> <a class="code" href="namespacemsgpack.html#af8c675c74116393a0b90e4dc64d18a0d">unpack</a>(</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  Iterator&& <a class="code" href="namespacemsgpack.html#ad52c02be11a42c58799707aa0b71ca4e">begin</a>, Iterator&& <a class="code" href="namespacemsgpack.html#a9426a4160106ee0a2574c731656ea9ac">end</a>,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a> f = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, <span class="keywordtype">void</span>* user_data = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  unpack_limit <span class="keyword">const</span>& limit = unpack_limit());</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="structmsgpack_1_1object.html">msgpack::object</a> <a class="code" href="namespacemsgpack.html#af8c675c74116393a0b90e4dc64d18a0d">unpack</a>(</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="classmsgpack_1_1zone.html">msgpack::zone</a>& z,</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  Iterator&& <a class="code" href="namespacemsgpack.html#ad52c02be11a42c58799707aa0b71ca4e">begin</a>, Iterator&& <a class="code" href="namespacemsgpack.html#a9426a4160106ee0a2574c731656ea9ac">end</a>,</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">bool</span>& referenced,</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a> f = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, <span class="keywordtype">void</span>* user_data = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>,</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  unpack_limit <span class="keyword">const</span>& limit = unpack_limit());</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Iterator></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="structmsgpack_1_1object.html">msgpack::object</a> <a class="code" href="namespacemsgpack.html#af8c675c74116393a0b90e4dc64d18a0d">unpack</a>(</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classmsgpack_1_1zone.html">msgpack::zone</a>& z,</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  Iterator&& <a class="code" href="namespacemsgpack.html#ad52c02be11a42c58799707aa0b71ca4e">begin</a>, Iterator&& <a class="code" href="namespacemsgpack.html#a9426a4160106ee0a2574c731656ea9ac">end</a>,</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a> f = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, <span class="keywordtype">void</span>* user_data = <a class="code" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>,</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  unpack_limit <span class="keyword">const</span>& limit = unpack_limit());</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <span class="comment">// MSGPACK_API_VERSION_NAMESPACE(v3)</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace msgpack</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#endif </span><span class="comment">// defined(MSGPACK_USE_X3_PARSE)</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#endif </span><span class="comment">// MSGPACK_V3_X3_UNPACK_DECL_HPP</span></div>
|
|
<div class="ttc" id="aclassmsgpack_1_1object__handle_html"><div class="ttname"><a href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a></div><div class="ttdoc">The class holds object and zone.</div><div class="ttdef"><b>Definition:</b> object.hpp:44</div></div>
|
|
<div class="ttc" id="aclassmsgpack_1_1zone_html"><div class="ttname"><a href="classmsgpack_1_1zone.html">msgpack::zone</a></div><div class="ttdef"><b>Definition:</b> cpp03_zone.hpp:31</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_1_1detail_html_a53b09020df222a85f50b415c705833c9"><div class="ttname"><a href="namespacemsgpack_1_1detail.html#a53b09020df222a85f50b415c705833c9">msgpack::detail::unpack_imp</a></div><div class="ttdeci">parse_return unpack_imp(const char *data, std::size_t len, std::size_t &off, msgpack::zone &result_zone, msgpack::object &result, bool &referenced, unpack_reference_func f=MSGPACK_NULLPTR, void *user_data=MSGPACK_NULLPTR, unpack_limit const &limit=unpack_limit())</div><div class="ttdef"><b>Definition:</b> unpack.hpp:1353</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_html"><div class="ttname"><a href="namespacemsgpack.html">msgpack</a></div><div class="ttdef"><b>Definition:</b> adaptor_base.hpp:15</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_html_a74841406f4ad1b1b1bf51d5290418697"><div class="ttname"><a href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">msgpack::unpack_reference_func</a></div><div class="ttdeci">bool(* unpack_reference_func)(msgpack::type::object_type type, std::size_t size, void *user_data)</div><div class="ttdoc">The type of reference or copy judging function.</div><div class="ttdef"><b>Definition:</b> unpack_decl.hpp:74</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_html_a9426a4160106ee0a2574c731656ea9ac"><div class="ttname"><a href="namespacemsgpack.html#a9426a4160106ee0a2574c731656ea9ac">msgpack::end</a></div><div class="ttdeci">msgpack::object_kv * end(msgpack::object_map &map)</div><div class="ttdef"><b>Definition:</b> iterator.hpp:25</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_html_ad52c02be11a42c58799707aa0b71ca4e"><div class="ttname"><a href="namespacemsgpack.html#ad52c02be11a42c58799707aa0b71ca4e">msgpack::begin</a></div><div class="ttdeci">msgpack::object_kv * begin(msgpack::object_map &map)</div><div class="ttdef"><b>Definition:</b> iterator.hpp:23</div></div>
|
|
<div class="ttc" id="anamespacemsgpack_html_af8c675c74116393a0b90e4dc64d18a0d"><div class="ttname"><a href="namespacemsgpack.html#af8c675c74116393a0b90e4dc64d18a0d">msgpack::unpack</a></div><div class="ttdeci">msgpack::object_handle unpack(const char *data, std::size_t len, std::size_t &off, bool &referenced, unpack_reference_func f, void *user_data, unpack_limit const &limit)</div><div class="ttdoc">Unpack msgpack::object from a buffer.</div><div class="ttdef"><b>Definition:</b> unpack.hpp:1397</div></div>
|
|
<div class="ttc" id="astructmsgpack_1_1object_html"><div class="ttname"><a href="structmsgpack_1_1object.html">msgpack::object</a></div><div class="ttdoc">Object class that corresponding to MessagePack format object.</div><div class="ttdef"><b>Definition:</b> object_fwd.hpp:75</div></div>
|
|
<div class="ttc" id="av1_2cpp__config__decl_8hpp_html_a68eb5e9337cb3cdcc7da1f4ab5333e26"><div class="ttname"><a href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a></div><div class="ttdeci">#define MSGPACK_NULLPTR</div><div class="ttdef"><b>Definition:</b> cpp_config_decl.hpp:85</div></div>
|
|
<div class="ttc" id="av1_2versioning_8hpp_html_afc7672e6f1fe2324a37d578e787408b8"><div class="ttname"><a href="v1_2versioning_8hpp.html#afc7672e6f1fe2324a37d578e787408b8">MSGPACK_API_VERSION_NAMESPACE</a></div><div class="ttdeci">#define MSGPACK_API_VERSION_NAMESPACE(ns)</div><div class="ttdef"><b>Definition:</b> versioning.hpp:66</div></div>
|
|
<div class="ttc" id="av2_2x3__unpack__decl_8hpp_html"><div class="ttname"><a href="v2_2x3__unpack__decl_8hpp.html">x3_unpack_decl.hpp</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|