1690 lines
116 KiB
HTML
1690 lines
116 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MPack: Tags and Common Elements</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" />
|
|
<link href="doxygen-mpack-css.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">MPack<span id="projectnumber"> 1.1.1</span>
|
|
</div>
|
|
<div id="projectbrief">A C encoding/decoding library for the MessagePack serialization format.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.5 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Tags and Common Elements</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<p >Contains types, constants and functions shared by both the encoding and decoding portions of MPack. </p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:structmpack__timestamp__t"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#structmpack__timestamp__t">mpack_timestamp_t</a></td></tr>
|
|
<tr class="memdesc:structmpack__timestamp__t"><td class="mdescLeft"> </td><td class="mdescRight">A timestamp. <a href="group__common.html#structmpack__timestamp__t">More...</a><br /></td></tr>
|
|
<tr class="separator:structmpack__timestamp__t"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ga38de074080bdd2554c23bdbcff720ebb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga38de074080bdd2554c23bdbcff720ebb">MPACK_LIBRARY_STRING</a></td></tr>
|
|
<tr class="memdesc:ga38de074080bdd2554c23bdbcff720ebb"><td class="mdescLeft"> </td><td class="mdescRight">A string describing MPack, containing the library name, version and debug mode. <a href="group__common.html#ga38de074080bdd2554c23bdbcff720ebb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga38de074080bdd2554c23bdbcff720ebb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae9198f5772b6f67b688d15c93812b764"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gae9198f5772b6f67b688d15c93812b764">MPACK_TIMESTAMP_NANOSECONDS_MAX</a>   999999999</td></tr>
|
|
<tr class="memdesc:gae9198f5772b6f67b688d15c93812b764"><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of nanoseconds for a timestamp. <a href="group__common.html#gae9198f5772b6f67b688d15c93812b764">More...</a><br /></td></tr>
|
|
<tr class="separator:gae9198f5772b6f67b688d15c93812b764"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a31c82e48e37c8ceeb3a17ae3ed1ebe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga5a31c82e48e37c8ceeb3a17ae3ed1ebe">MPACK_VERSION</a></td></tr>
|
|
<tr class="memdesc:ga5a31c82e48e37c8ceeb3a17ae3ed1ebe"><td class="mdescLeft"> </td><td class="mdescRight">A number containing the version number of MPack for comparison purposes. <a href="group__common.html#ga5a31c82e48e37c8ceeb3a17ae3ed1ebe">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5a31c82e48e37c8ceeb3a17ae3ed1ebe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1ea07f6899bfd9d22cddcb87ea9aeedc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga1ea07f6899bfd9d22cddcb87ea9aeedc">MPACK_VERSION_AT_LEAST</a>(major, minor, patch)    (<a class="el" href="group__common.html#ga5a31c82e48e37c8ceeb3a17ae3ed1ebe">MPACK_VERSION</a> >= (((major) * 10000) + ((minor) * 100) + (patch)))</td></tr>
|
|
<tr class="memdesc:ga1ea07f6899bfd9d22cddcb87ea9aeedc"><td class="mdescLeft"> </td><td class="mdescRight">A macro to test for a minimum version of MPack. <a href="group__common.html#ga1ea07f6899bfd9d22cddcb87ea9aeedc">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1ea07f6899bfd9d22cddcb87ea9aeedc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaebab06d0583dbde63f0efe079c17aa99"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaebab06d0583dbde63f0efe079c17aa99">MPACK_VERSION_MAJOR</a>   1</td></tr>
|
|
<tr class="memdesc:gaebab06d0583dbde63f0efe079c17aa99"><td class="mdescLeft"> </td><td class="mdescRight">The major version number of MPack. <a href="group__common.html#gaebab06d0583dbde63f0efe079c17aa99">More...</a><br /></td></tr>
|
|
<tr class="separator:gaebab06d0583dbde63f0efe079c17aa99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga52c251cf33faf26bf8405e1d0a8648e1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga52c251cf33faf26bf8405e1d0a8648e1">MPACK_VERSION_MINOR</a>   1</td></tr>
|
|
<tr class="memdesc:ga52c251cf33faf26bf8405e1d0a8648e1"><td class="mdescLeft"> </td><td class="mdescRight">The minor version number of MPack. <a href="group__common.html#ga52c251cf33faf26bf8405e1d0a8648e1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga52c251cf33faf26bf8405e1d0a8648e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3e836544ced44daa6f194288f7db9868"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga3e836544ced44daa6f194288f7db9868">MPACK_VERSION_PATCH</a>   1</td></tr>
|
|
<tr class="memdesc:ga3e836544ced44daa6f194288f7db9868"><td class="mdescLeft"> </td><td class="mdescRight">The patch version number of MPack. <a href="group__common.html#ga3e836544ced44daa6f194288f7db9868">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3e836544ced44daa6f194288f7db9868"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacd1814c8320b862ae0c10d2a14e629ed"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gacd1814c8320b862ae0c10d2a14e629ed">MPACK_VERSION_STRING</a></td></tr>
|
|
<tr class="memdesc:gacd1814c8320b862ae0c10d2a14e629ed"><td class="mdescLeft"> </td><td class="mdescRight">A string containing the MPack version. <a href="group__common.html#gacd1814c8320b862ae0c10d2a14e629ed">More...</a><br /></td></tr>
|
|
<tr class="separator:gacd1814c8320b862ae0c10d2a14e629ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga008da69ac6b5582a893f2d2ffd37f4ac"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a></td></tr>
|
|
<tr class="memdesc:ga008da69ac6b5582a893f2d2ffd37f4ac"><td class="mdescLeft"> </td><td class="mdescRight">An MPack tag is a MessagePack object header. <a href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">More...</a><br /></td></tr>
|
|
<tr class="separator:ga008da69ac6b5582a893f2d2ffd37f4ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga9d9f282ca4183ab5190e09d04c1f74c4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga9d9f282ca4183ab5190e09d04c1f74c4">mpack_error_t</a> { <br />
|
|
  <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a642a07519ef145fc9dd1068230c4a661">mpack_ok</a> = 0
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a6581b50527f1c278f852c91bea70f847">mpack_error_io</a> = 2
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a6d6111704fd59c034f9958c353c6da93">mpack_error_invalid</a>
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a8618d0842dfb9b10c09feccef4794eee">mpack_error_unsupported</a>
|
|
, <br />
|
|
  <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4ac91d0dcefbb9c7b9f41403bbc674aef2">mpack_error_type</a>
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a575cd33925a41fe7c157162b233b8308">mpack_error_too_big</a>
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a39db970382d81fc5a4b80dd0b61df5cf">mpack_error_memory</a>
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4ae35afae5a24379821fa74315be1aa0d6">mpack_error_bug</a>
|
|
, <br />
|
|
  <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4ae53cbed8fcc42915d71ae37d121b22e8">mpack_error_data</a>
|
|
, <a class="el" href="group__common.html#gga9d9f282ca4183ab5190e09d04c1f74c4a0b01d4850a0856cdf7a24bf22e3a5e14">mpack_error_eof</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ga9d9f282ca4183ab5190e09d04c1f74c4"><td class="mdescLeft"> </td><td class="mdescRight">Error states for MPack objects. <a href="group__common.html#ga9d9f282ca4183ab5190e09d04c1f74c4">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9d9f282ca4183ab5190e09d04c1f74c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga22f03cf1240d5a917e1b3e7be8ab327e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a> { <br />
|
|
  <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea0f53cbbeba7fd1b87394980b832c3fb9">mpack_type_missing</a> = 0
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eaade66ddfcf1133c0ac00015ab26bd2b4">mpack_type_nil</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea09eeb9595c0537ed4cdf2b11a4dd4d59">mpack_type_bool</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e">mpack_type_int</a>
|
|
, <br />
|
|
  <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654">mpack_type_uint</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b">mpack_type_float</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca">mpack_type_double</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12">mpack_type_str</a>
|
|
, <br />
|
|
  <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6">mpack_type_bin</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eabc1bfe5856870df99fa51a39923e6349">mpack_type_array</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea0cdc6eb2c069333405d0d23602f7006a">mpack_type_map</a>
|
|
, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee">mpack_type_ext</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ga22f03cf1240d5a917e1b3e7be8ab327e"><td class="mdescLeft"> </td><td class="mdescRight">Defines the type of a MessagePack tag. <a href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">More...</a><br /></td></tr>
|
|
<tr class="separator:ga22f03cf1240d5a917e1b3e7be8ab327e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaba84f7d6b203a1f51f2a3e10c80318e2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaba84f7d6b203a1f51f2a3e10c80318e2">mpack_version_t</a> { <a class="el" href="group__common.html#ggaba84f7d6b203a1f51f2a3e10c80318e2a4f793c44ed56ffed4ea441cb47e2a41d">mpack_version_v4</a> = 4
|
|
, <a class="el" href="group__common.html#ggaba84f7d6b203a1f51f2a3e10c80318e2aec7501edf20073ac35f31a66104f815e">mpack_version_v5</a> = 5
|
|
, <a class="el" href="group__common.html#ggaba84f7d6b203a1f51f2a3e10c80318e2a8c85d0a71537cbf52f57125bf6e55fcb">mpack_version_current</a> = mpack_version_v5
|
|
}</td></tr>
|
|
<tr class="memdesc:gaba84f7d6b203a1f51f2a3e10c80318e2"><td class="mdescLeft"> </td><td class="mdescRight">Versions of the MessagePack format. <a href="group__common.html#gaba84f7d6b203a1f51f2a3e10c80318e2">More...</a><br /></td></tr>
|
|
<tr class="separator:gaba84f7d6b203a1f51f2a3e10c80318e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gad2c776bf825722c9579f6003ad6ffe4b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gad2c776bf825722c9579f6003ad6ffe4b">mpack_error_to_string</a> (<a class="el" href="group__common.html#ga9d9f282ca4183ab5190e09d04c1f74c4">mpack_error_t</a> error)</td></tr>
|
|
<tr class="memdesc:gad2c776bf825722c9579f6003ad6ffe4b"><td class="mdescLeft"> </td><td class="mdescRight">Converts an MPack error to a string. <a href="group__common.html#gad2c776bf825722c9579f6003ad6ffe4b">More...</a><br /></td></tr>
|
|
<tr class="separator:gad2c776bf825722c9579f6003ad6ffe4b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6d3ec73b8a671b7d4dd8e3d5670ff058"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6d3ec73b8a671b7d4dd8e3d5670ff058">mpack_type_to_string</a> (<a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a> type)</td></tr>
|
|
<tr class="memdesc:ga6d3ec73b8a671b7d4dd8e3d5670ff058"><td class="mdescLeft"> </td><td class="mdescRight">Converts an MPack type to a string. <a href="group__common.html#ga6d3ec73b8a671b7d4dd8e3d5670ff058">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6d3ec73b8a671b7d4dd8e3d5670ff058"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader">Tag Generators</h2></td></tr>
|
|
<tr class="memitem:ga651e566bbe864d430b7fc76e08c6744d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga651e566bbe864d430b7fc76e08c6744d">mpack_tag_make_nil</a> (void)</td></tr>
|
|
<tr class="memdesc:ga651e566bbe864d430b7fc76e08c6744d"><td class="mdescLeft"> </td><td class="mdescRight">Generates a nil tag. <a href="group__common.html#ga651e566bbe864d430b7fc76e08c6744d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga651e566bbe864d430b7fc76e08c6744d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadc1fbc1c6d9440c886b31f4eaaa51e59"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gadc1fbc1c6d9440c886b31f4eaaa51e59">mpack_tag_make_bool</a> (bool value)</td></tr>
|
|
<tr class="memdesc:gadc1fbc1c6d9440c886b31f4eaaa51e59"><td class="mdescLeft"> </td><td class="mdescRight">Generates a bool tag. <a href="group__common.html#gadc1fbc1c6d9440c886b31f4eaaa51e59">More...</a><br /></td></tr>
|
|
<tr class="separator:gadc1fbc1c6d9440c886b31f4eaaa51e59"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaee3b842534d3a83a6e4df02073559db0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaee3b842534d3a83a6e4df02073559db0">mpack_tag_make_true</a> (void)</td></tr>
|
|
<tr class="memdesc:gaee3b842534d3a83a6e4df02073559db0"><td class="mdescLeft"> </td><td class="mdescRight">Generates a bool tag with value true. <a href="group__common.html#gaee3b842534d3a83a6e4df02073559db0">More...</a><br /></td></tr>
|
|
<tr class="separator:gaee3b842534d3a83a6e4df02073559db0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8808d78b72d2219c220482b7cfc41f38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga8808d78b72d2219c220482b7cfc41f38">mpack_tag_make_false</a> (void)</td></tr>
|
|
<tr class="memdesc:ga8808d78b72d2219c220482b7cfc41f38"><td class="mdescLeft"> </td><td class="mdescRight">Generates a bool tag with value false. <a href="group__common.html#ga8808d78b72d2219c220482b7cfc41f38">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8808d78b72d2219c220482b7cfc41f38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7e1dd48858270d1be4491eeafeedc1e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga7e1dd48858270d1be4491eeafeedc1e2">mpack_tag_make_int</a> (int64_t value)</td></tr>
|
|
<tr class="memdesc:ga7e1dd48858270d1be4491eeafeedc1e2"><td class="mdescLeft"> </td><td class="mdescRight">Generates a signed int tag. <a href="group__common.html#ga7e1dd48858270d1be4491eeafeedc1e2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7e1dd48858270d1be4491eeafeedc1e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4848b8753b0325d5d7f1f7f46cea8b63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga4848b8753b0325d5d7f1f7f46cea8b63">mpack_tag_make_uint</a> (uint64_t value)</td></tr>
|
|
<tr class="memdesc:ga4848b8753b0325d5d7f1f7f46cea8b63"><td class="mdescLeft"> </td><td class="mdescRight">Generates an unsigned int tag. <a href="group__common.html#ga4848b8753b0325d5d7f1f7f46cea8b63">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4848b8753b0325d5d7f1f7f46cea8b63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9c833cbf132df422350576d5b58050b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga9c833cbf132df422350576d5b58050b1">mpack_tag_make_float</a> (float value)</td></tr>
|
|
<tr class="memdesc:ga9c833cbf132df422350576d5b58050b1"><td class="mdescLeft"> </td><td class="mdescRight">Generates a float tag. <a href="group__common.html#ga9c833cbf132df422350576d5b58050b1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9c833cbf132df422350576d5b58050b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4efab5d78b1a5e8b39bee50e5ada3dd3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga4efab5d78b1a5e8b39bee50e5ada3dd3">mpack_tag_make_double</a> (double value)</td></tr>
|
|
<tr class="memdesc:ga4efab5d78b1a5e8b39bee50e5ada3dd3"><td class="mdescLeft"> </td><td class="mdescRight">Generates a double tag. <a href="group__common.html#ga4efab5d78b1a5e8b39bee50e5ada3dd3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4efab5d78b1a5e8b39bee50e5ada3dd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6fbedd040803aebc19ed0ebab5965de3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6fbedd040803aebc19ed0ebab5965de3">mpack_tag_make_array</a> (uint32_t count)</td></tr>
|
|
<tr class="memdesc:ga6fbedd040803aebc19ed0ebab5965de3"><td class="mdescLeft"> </td><td class="mdescRight">Generates an array tag. <a href="group__common.html#ga6fbedd040803aebc19ed0ebab5965de3">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6fbedd040803aebc19ed0ebab5965de3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8c36771143fb793e5417934a5491f3cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga8c36771143fb793e5417934a5491f3cb">mpack_tag_make_map</a> (uint32_t count)</td></tr>
|
|
<tr class="memdesc:ga8c36771143fb793e5417934a5491f3cb"><td class="mdescLeft"> </td><td class="mdescRight">Generates a map tag. <a href="group__common.html#ga8c36771143fb793e5417934a5491f3cb">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8c36771143fb793e5417934a5491f3cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6c01251057f6e6c68fee26ffdd339cf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6c01251057f6e6c68fee26ffdd339cf0">mpack_tag_make_str</a> (uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga6c01251057f6e6c68fee26ffdd339cf0"><td class="mdescLeft"> </td><td class="mdescRight">Generates a str tag. <a href="group__common.html#ga6c01251057f6e6c68fee26ffdd339cf0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6c01251057f6e6c68fee26ffdd339cf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a3c95acc8156125706dcf5ce05c59e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga5a3c95acc8156125706dcf5ce05c59e0">mpack_tag_make_bin</a> (uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga5a3c95acc8156125706dcf5ce05c59e0"><td class="mdescLeft"> </td><td class="mdescRight">Generates a bin tag. <a href="group__common.html#ga5a3c95acc8156125706dcf5ce05c59e0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5a3c95acc8156125706dcf5ce05c59e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5527a08e30b9e0b656804d144ab6ee32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga5527a08e30b9e0b656804d144ab6ee32">mpack_tag_make_ext</a> (int8_t exttype, uint32_t length)</td></tr>
|
|
<tr class="memdesc:ga5527a08e30b9e0b656804d144ab6ee32"><td class="mdescLeft"> </td><td class="mdescRight">Generates an ext tag. <a href="group__common.html#ga5527a08e30b9e0b656804d144ab6ee32">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5527a08e30b9e0b656804d144ab6ee32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1c7d1b8ef75af240c8efefeb26cc6736"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga1c7d1b8ef75af240c8efefeb26cc6736">MPACK_TAG_ZERO</a>   {(<a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a>)0, 0, {0}}</td></tr>
|
|
<tr class="memdesc:ga1c7d1b8ef75af240c8efefeb26cc6736"><td class="mdescLeft"> </td><td class="mdescRight">An <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> initializer that zeroes the given tag. <a href="group__common.html#ga1c7d1b8ef75af240c8efefeb26cc6736">More...</a><br /></td></tr>
|
|
<tr class="separator:ga1c7d1b8ef75af240c8efefeb26cc6736"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader">Tag Querying Functions</h2></td></tr>
|
|
<tr class="memitem:gaf3c75dc78631727344e154b82a73d37a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaf3c75dc78631727344e154b82a73d37a">mpack_tag_type</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:gaf3c75dc78631727344e154b82a73d37a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of a tag. <a href="group__common.html#gaf3c75dc78631727344e154b82a73d37a">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf3c75dc78631727344e154b82a73d37a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8c0f7e30e7c3484ea96b8f154bbf72a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga8c0f7e30e7c3484ea96b8f154bbf72a1">mpack_tag_bool_value</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga8c0f7e30e7c3484ea96b8f154bbf72a1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the boolean value of a bool-type tag. <a href="group__common.html#ga8c0f7e30e7c3484ea96b8f154bbf72a1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga8c0f7e30e7c3484ea96b8f154bbf72a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gace2efaa8a795db3365f9a0deee4e3391"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gace2efaa8a795db3365f9a0deee4e3391">mpack_tag_int_value</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:gace2efaa8a795db3365f9a0deee4e3391"><td class="mdescLeft"> </td><td class="mdescRight">Gets the signed integer value of an int-type tag. <a href="group__common.html#gace2efaa8a795db3365f9a0deee4e3391">More...</a><br /></td></tr>
|
|
<tr class="separator:gace2efaa8a795db3365f9a0deee4e3391"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaec6577f0333c2a7775c5e78757fe89f8"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaec6577f0333c2a7775c5e78757fe89f8">mpack_tag_uint_value</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:gaec6577f0333c2a7775c5e78757fe89f8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the unsigned integer value of a uint-type tag. <a href="group__common.html#gaec6577f0333c2a7775c5e78757fe89f8">More...</a><br /></td></tr>
|
|
<tr class="separator:gaec6577f0333c2a7775c5e78757fe89f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6013528247a4cb06928013cde4633814"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6013528247a4cb06928013cde4633814">mpack_tag_float_value</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga6013528247a4cb06928013cde4633814"><td class="mdescLeft"> </td><td class="mdescRight">Gets the float value of a float-type tag. <a href="group__common.html#ga6013528247a4cb06928013cde4633814">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6013528247a4cb06928013cde4633814"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga379fdaed101e1121d0be65a09fa6e5c0"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga379fdaed101e1121d0be65a09fa6e5c0">mpack_tag_double_value</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga379fdaed101e1121d0be65a09fa6e5c0"><td class="mdescLeft"> </td><td class="mdescRight">Gets the double value of a double-type tag. <a href="group__common.html#ga379fdaed101e1121d0be65a09fa6e5c0">More...</a><br /></td></tr>
|
|
<tr class="separator:ga379fdaed101e1121d0be65a09fa6e5c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga071204c83da525e2925b4ba13e5eafa6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga071204c83da525e2925b4ba13e5eafa6">mpack_tag_array_count</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga071204c83da525e2925b4ba13e5eafa6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of elements in an array tag. <a href="group__common.html#ga071204c83da525e2925b4ba13e5eafa6">More...</a><br /></td></tr>
|
|
<tr class="separator:ga071204c83da525e2925b4ba13e5eafa6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6fbba834bc069a6973738e00a6106c56"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6fbba834bc069a6973738e00a6106c56">mpack_tag_map_count</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga6fbba834bc069a6973738e00a6106c56"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of key-value pairs in a map tag. <a href="group__common.html#ga6fbba834bc069a6973738e00a6106c56">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6fbba834bc069a6973738e00a6106c56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6a8dc7f85c6673b68454e2ca38c07a5a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6a8dc7f85c6673b68454e2ca38c07a5a">mpack_tag_str_length</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga6a8dc7f85c6673b68454e2ca38c07a5a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length in bytes of a str-type tag. <a href="group__common.html#ga6a8dc7f85c6673b68454e2ca38c07a5a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6a8dc7f85c6673b68454e2ca38c07a5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga658da0a45688be8ba6e22bab53784754"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga658da0a45688be8ba6e22bab53784754">mpack_tag_bin_length</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga658da0a45688be8ba6e22bab53784754"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length in bytes of a bin-type tag. <a href="group__common.html#ga658da0a45688be8ba6e22bab53784754">More...</a><br /></td></tr>
|
|
<tr class="separator:ga658da0a45688be8ba6e22bab53784754"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf68d677e5e05d08747703b9e7de122b5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaf68d677e5e05d08747703b9e7de122b5">mpack_tag_ext_length</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:gaf68d677e5e05d08747703b9e7de122b5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length in bytes of an ext-type tag. <a href="group__common.html#gaf68d677e5e05d08747703b9e7de122b5">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf68d677e5e05d08747703b9e7de122b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga65340d1eb1a2270c9f9618bb4ea8228d"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga65340d1eb1a2270c9f9618bb4ea8228d">mpack_tag_ext_exttype</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga65340d1eb1a2270c9f9618bb4ea8228d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the extension type (exttype) of an ext-type tag. <a href="group__common.html#ga65340d1eb1a2270c9f9618bb4ea8228d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga65340d1eb1a2270c9f9618bb4ea8228d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga033c16708956cd2def6c81cbe6b39d21"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga033c16708956cd2def6c81cbe6b39d21">mpack_tag_bytes</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> *tag)</td></tr>
|
|
<tr class="memdesc:ga033c16708956cd2def6c81cbe6b39d21"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length in bytes of a str-, bin- or ext-type tag. <a href="group__common.html#ga033c16708956cd2def6c81cbe6b39d21">More...</a><br /></td></tr>
|
|
<tr class="separator:ga033c16708956cd2def6c81cbe6b39d21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader">Other tag functions</h2></td></tr>
|
|
<tr class="memitem:ga959a1299fde759b8fab2341cfb1355b8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga959a1299fde759b8fab2341cfb1355b8">mpack_tag_cmp</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> left, <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> right)</td></tr>
|
|
<tr class="memdesc:ga959a1299fde759b8fab2341cfb1355b8"><td class="mdescLeft"> </td><td class="mdescRight">Compares two tags with an arbitrary fixed ordering. <a href="group__common.html#ga959a1299fde759b8fab2341cfb1355b8">More...</a><br /></td></tr>
|
|
<tr class="separator:ga959a1299fde759b8fab2341cfb1355b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6278d8f1818309765fb7e30c14440b23"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga6278d8f1818309765fb7e30c14440b23">mpack_tag_equal</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> left, <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> right)</td></tr>
|
|
<tr class="memdesc:ga6278d8f1818309765fb7e30c14440b23"><td class="mdescLeft"> </td><td class="mdescRight">Compares two tags for equality. <a href="group__common.html#ga6278d8f1818309765fb7e30c14440b23">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6278d8f1818309765fb7e30c14440b23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab7fb60017700ae126a0fe0fa3f3cadcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gab7fb60017700ae126a0fe0fa3f3cadcb">mpack_tag_debug_pseudo_json</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> tag, char *buffer, size_t buffer_size, const char *prefix, size_t prefix_size)</td></tr>
|
|
<tr class="memdesc:gab7fb60017700ae126a0fe0fa3f3cadcb"><td class="mdescLeft"> </td><td class="mdescRight">Generates a json-like debug description of the given tag into the given buffer. <a href="group__common.html#gab7fb60017700ae126a0fe0fa3f3cadcb">More...</a><br /></td></tr>
|
|
<tr class="separator:gab7fb60017700ae126a0fe0fa3f3cadcb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7451be24eeb32354af269a9071a14245"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga7451be24eeb32354af269a9071a14245">mpack_tag_debug_describe</a> (<a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> tag, char *buffer, size_t buffer_size)</td></tr>
|
|
<tr class="memdesc:ga7451be24eeb32354af269a9071a14245"><td class="mdescLeft"> </td><td class="mdescRight">Generates a debug string description of the given tag into the given buffer. <a href="group__common.html#ga7451be24eeb32354af269a9071a14245">More...</a><br /></td></tr>
|
|
<tr class="separator:ga7451be24eeb32354af269a9071a14245"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa1d2103131383ae41a543a65bd0929b7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaa1d2103131383ae41a543a65bd0929b7">MPACK_EXTTYPE_TIMESTAMP</a>   ((int8_t)(-1))</td></tr>
|
|
<tr class="memdesc:gaa1d2103131383ae41a543a65bd0929b7"><td class="mdescLeft"> </td><td class="mdescRight">The extension type for a timestamp. <a href="group__common.html#gaa1d2103131383ae41a543a65bd0929b7">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa1d2103131383ae41a543a65bd0929b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader">Deprecated Tag Generators</h2></td></tr>
|
|
<tr class="memitem:ga7dddc1921b402cd058bd32099db02fd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga7dddc1921b402cd058bd32099db02fd0">mpack_tag_nil</a> (void)</td></tr>
|
|
<tr class="separator:ga7dddc1921b402cd058bd32099db02fd0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaafdb8f338605dfb8bf1e1edb6c07940e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaafdb8f338605dfb8bf1e1edb6c07940e">mpack_tag_bool</a> (bool value)</td></tr>
|
|
<tr class="separator:gaafdb8f338605dfb8bf1e1edb6c07940e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9408e69df94e21714579edfc95736006"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga9408e69df94e21714579edfc95736006">mpack_tag_true</a> (void)</td></tr>
|
|
<tr class="separator:ga9408e69df94e21714579edfc95736006"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaff6b2c99bc922aa51e138cc9b16717e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaaff6b2c99bc922aa51e138cc9b16717e">mpack_tag_false</a> (void)</td></tr>
|
|
<tr class="separator:gaaff6b2c99bc922aa51e138cc9b16717e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga79fe4bddaffe6ebe8d97e362fe90ee5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga79fe4bddaffe6ebe8d97e362fe90ee5c">mpack_tag_int</a> (int64_t value)</td></tr>
|
|
<tr class="separator:ga79fe4bddaffe6ebe8d97e362fe90ee5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae3e808c63fa0ba040429f955249791d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gae3e808c63fa0ba040429f955249791d2">mpack_tag_uint</a> (uint64_t value)</td></tr>
|
|
<tr class="separator:gae3e808c63fa0ba040429f955249791d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9323e7f5d3f615fcab945ff909fa5673"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga9323e7f5d3f615fcab945ff909fa5673">mpack_tag_float</a> (float value)</td></tr>
|
|
<tr class="separator:ga9323e7f5d3f615fcab945ff909fa5673"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac9f0e0d6573ffafb1536ee6f02b742b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gac9f0e0d6573ffafb1536ee6f02b742b6">mpack_tag_double</a> (double value)</td></tr>
|
|
<tr class="separator:gac9f0e0d6573ffafb1536ee6f02b742b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga31f7f337ff772a8e91af5e8394287ef4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga31f7f337ff772a8e91af5e8394287ef4">mpack_tag_array</a> (int32_t count)</td></tr>
|
|
<tr class="separator:ga31f7f337ff772a8e91af5e8394287ef4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9d0c0c98bad176e48b23878a7b1eae4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga9d0c0c98bad176e48b23878a7b1eae4f">mpack_tag_map</a> (int32_t count)</td></tr>
|
|
<tr class="separator:ga9d0c0c98bad176e48b23878a7b1eae4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga583cda927620b566cbd7b75df0555ea6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#ga583cda927620b566cbd7b75df0555ea6">mpack_tag_str</a> (int32_t length)</td></tr>
|
|
<tr class="separator:ga583cda927620b566cbd7b75df0555ea6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad193672644de9af88290b598ff8d2b8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gad193672644de9af88290b598ff8d2b8c">mpack_tag_bin</a> (int32_t length)</td></tr>
|
|
<tr class="separator:gad193672644de9af88290b598ff8d2b8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa6c5f417a0c6e24d71965105b700dc90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__common.html#gaa6c5f417a0c6e24d71965105b700dc90">mpack_tag_ext</a> (int8_t exttype, int32_t length)</td></tr>
|
|
<tr class="separator:gaa6c5f417a0c6e24d71965105b700dc90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
|
|
<a name="structmpack__timestamp__t" id="structmpack__timestamp__t"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#structmpack__timestamp__t">◆ </a></span>mpack_timestamp_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct mpack_timestamp_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<div class="textblock"><p >A timestamp. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>. </dd></dl>
|
|
</div><table class="fieldtable">
|
|
<tr><th colspan="3">Data Fields</th></tr>
|
|
<tr><td class="fieldtype">
|
|
<a id="a5a516cf52200d8de7c2cc149e3be4e5e" name="a5a516cf52200d8de7c2cc149e3be4e5e"></a>uint32_t</td>
|
|
<td class="fieldname">
|
|
nanoseconds</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
<tr><td class="fieldtype">
|
|
<a id="a6a9e302554ab645b80d08ccd697031af" name="a6a9e302554ab645b80d08ccd697031af"></a>int64_t</td>
|
|
<td class="fieldname">
|
|
seconds</td>
|
|
<td class="fielddoc">
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="gaa1d2103131383ae41a543a65bd0929b7" name="gaa1d2103131383ae41a543a65bd0929b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa1d2103131383ae41a543a65bd0929b7">◆ </a></span>MPACK_EXTTYPE_TIMESTAMP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_EXTTYPE_TIMESTAMP   ((int8_t)(-1))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The extension type for a timestamp. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga38de074080bdd2554c23bdbcff720ebb" name="ga38de074080bdd2554c23bdbcff720ebb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga38de074080bdd2554c23bdbcff720ebb">◆ </a></span>MPACK_LIBRARY_STRING</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_LIBRARY_STRING</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A string describing MPack, containing the library name, version and debug mode. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1c7d1b8ef75af240c8efefeb26cc6736" name="ga1c7d1b8ef75af240c8efefeb26cc6736"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1c7d1b8ef75af240c8efefeb26cc6736">◆ </a></span>MPACK_TAG_ZERO</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_TAG_ZERO   {(<a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a>)0, 0, {0}}</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> initializer that zeroes the given tag. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This does not make the tag nil! The tag's type is invalid when initialized this way. Use <a class="el" href="group__common.html#ga651e566bbe864d430b7fc76e08c6744d">mpack_tag_make_nil()</a> to generate a nil tag. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae9198f5772b6f67b688d15c93812b764" name="gae9198f5772b6f67b688d15c93812b764"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae9198f5772b6f67b688d15c93812b764">◆ </a></span>MPACK_TIMESTAMP_NANOSECONDS_MAX</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_TIMESTAMP_NANOSECONDS_MAX   999999999</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The maximum value of nanoseconds for a timestamp. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5a31c82e48e37c8ceeb3a17ae3ed1ebe" name="ga5a31c82e48e37c8ceeb3a17ae3ed1ebe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5a31c82e48e37c8ceeb3a17ae3ed1ebe">◆ </a></span>MPACK_VERSION</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> ((<a class="code hl_define" href="group__common.html#gaebab06d0583dbde63f0efe079c17aa99">MPACK_VERSION_MAJOR</a> * 10000) + \</div>
|
|
<div class="line"> (<a class="code hl_define" href="group__common.html#ga52c251cf33faf26bf8405e1d0a8648e1">MPACK_VERSION_MINOR</a> * 100) + <a class="code hl_define" href="group__common.html#ga3e836544ced44daa6f194288f7db9868">MPACK_VERSION_PATCH</a>)</div>
|
|
<div class="ttc" id="agroup__common_html_ga3e836544ced44daa6f194288f7db9868"><div class="ttname"><a href="group__common.html#ga3e836544ced44daa6f194288f7db9868">MPACK_VERSION_PATCH</a></div><div class="ttdeci">#define MPACK_VERSION_PATCH</div><div class="ttdoc">The patch version number of MPack.</div><div class="ttdef"><b>Definition:</b> mpack-common.h:55</div></div>
|
|
<div class="ttc" id="agroup__common_html_ga52c251cf33faf26bf8405e1d0a8648e1"><div class="ttname"><a href="group__common.html#ga52c251cf33faf26bf8405e1d0a8648e1">MPACK_VERSION_MINOR</a></div><div class="ttdeci">#define MPACK_VERSION_MINOR</div><div class="ttdoc">The minor version number of MPack.</div><div class="ttdef"><b>Definition:</b> mpack-common.h:54</div></div>
|
|
<div class="ttc" id="agroup__common_html_gaebab06d0583dbde63f0efe079c17aa99"><div class="ttname"><a href="group__common.html#gaebab06d0583dbde63f0efe079c17aa99">MPACK_VERSION_MAJOR</a></div><div class="ttdeci">#define MPACK_VERSION_MAJOR</div><div class="ttdoc">The major version number of MPack.</div><div class="ttdef"><b>Definition:</b> mpack-common.h:53</div></div>
|
|
</div><!-- fragment -->
|
|
<p>A number containing the version number of MPack for comparison purposes. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga1ea07f6899bfd9d22cddcb87ea9aeedc" name="ga1ea07f6899bfd9d22cddcb87ea9aeedc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1ea07f6899bfd9d22cddcb87ea9aeedc">◆ </a></span>MPACK_VERSION_AT_LEAST</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION_AT_LEAST</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">major, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">minor, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">patch </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>    (<a class="el" href="group__common.html#ga5a31c82e48e37c8ceeb3a17ae3ed1ebe">MPACK_VERSION</a> >= (((major) * 10000) + ((minor) * 100) + (patch)))</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A macro to test for a minimum version of MPack. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaebab06d0583dbde63f0efe079c17aa99" name="gaebab06d0583dbde63f0efe079c17aa99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaebab06d0583dbde63f0efe079c17aa99">◆ </a></span>MPACK_VERSION_MAJOR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION_MAJOR   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The major version number of MPack. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga52c251cf33faf26bf8405e1d0a8648e1" name="ga52c251cf33faf26bf8405e1d0a8648e1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga52c251cf33faf26bf8405e1d0a8648e1">◆ </a></span>MPACK_VERSION_MINOR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION_MINOR   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The minor version number of MPack. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3e836544ced44daa6f194288f7db9868" name="ga3e836544ced44daa6f194288f7db9868"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3e836544ced44daa6f194288f7db9868">◆ </a></span>MPACK_VERSION_PATCH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION_PATCH   1</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The patch version number of MPack. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacd1814c8320b862ae0c10d2a14e629ed" name="gacd1814c8320b862ae0c10d2a14e629ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacd1814c8320b862ae0c10d2a14e629ed">◆ </a></span>MPACK_VERSION_STRING</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MPACK_VERSION_STRING</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A string containing the MPack version. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ga008da69ac6b5582a893f2d2ffd37f4ac" name="ga008da69ac6b5582a893f2d2ffd37f4ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga008da69ac6b5582a893f2d2ffd37f4ac">◆ </a></span>mpack_tag_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> <a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>An MPack tag is a MessagePack object header. </p>
|
|
<p >It is a variant type representing any kind of object, and includes the length of compound types (e.g. map, array, string) or the value of non-compound types (e.g. boolean, integer, float.)</p>
|
|
<p >If the type is compound (str, bin, ext, array or map), the contained elements or bytes are stored separately.</p>
|
|
<p >This structure is opaque; its fields should not be accessed outside of MPack. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga9d9f282ca4183ab5190e09d04c1f74c4" name="ga9d9f282ca4183ab5190e09d04c1f74c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9d9f282ca4183ab5190e09d04c1f74c4">◆ </a></span>mpack_error_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__common.html#ga9d9f282ca4183ab5190e09d04c1f74c4">mpack_error_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Error states for MPack objects. </p>
|
|
<p >When a reader, writer, or tree is in an error state, all subsequent calls are ignored and their return values are nil/zero. You should check whether the source is in an error state before using such values. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a642a07519ef145fc9dd1068230c4a661" name="gga9d9f282ca4183ab5190e09d04c1f74c4a642a07519ef145fc9dd1068230c4a661"></a>mpack_ok </td><td class="fielddoc"><p >No error. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a6581b50527f1c278f852c91bea70f847" name="gga9d9f282ca4183ab5190e09d04c1f74c4a6581b50527f1c278f852c91bea70f847"></a>mpack_error_io </td><td class="fielddoc"><p >The reader or writer failed to fill or flush, or some other file or socket error occurred. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a6d6111704fd59c034f9958c353c6da93" name="gga9d9f282ca4183ab5190e09d04c1f74c4a6d6111704fd59c034f9958c353c6da93"></a>mpack_error_invalid </td><td class="fielddoc"><p >The data read is not valid MessagePack. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a8618d0842dfb9b10c09feccef4794eee" name="gga9d9f282ca4183ab5190e09d04c1f74c4a8618d0842dfb9b10c09feccef4794eee"></a>mpack_error_unsupported </td><td class="fielddoc"><p >The data read is not supported by this configuration of MPack. </p>
|
|
<p >(See <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>.) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4ac91d0dcefbb9c7b9f41403bbc674aef2" name="gga9d9f282ca4183ab5190e09d04c1f74c4ac91d0dcefbb9c7b9f41403bbc674aef2"></a>mpack_error_type </td><td class="fielddoc"><p >The type or value range did not match what was expected by the caller. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a575cd33925a41fe7c157162b233b8308" name="gga9d9f282ca4183ab5190e09d04c1f74c4a575cd33925a41fe7c157162b233b8308"></a>mpack_error_too_big </td><td class="fielddoc"><p >A read or write was bigger than the maximum size allowed for that operation. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a39db970382d81fc5a4b80dd0b61df5cf" name="gga9d9f282ca4183ab5190e09d04c1f74c4a39db970382d81fc5a4b80dd0b61df5cf"></a>mpack_error_memory </td><td class="fielddoc"><p >An allocation failure occurred. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4ae35afae5a24379821fa74315be1aa0d6" name="gga9d9f282ca4183ab5190e09d04c1f74c4ae35afae5a24379821fa74315be1aa0d6"></a>mpack_error_bug </td><td class="fielddoc"><p >The MPack API was used incorrectly. </p>
|
|
<p >(This will always assert in debug mode.) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4ae53cbed8fcc42915d71ae37d121b22e8" name="gga9d9f282ca4183ab5190e09d04c1f74c4ae53cbed8fcc42915d71ae37d121b22e8"></a>mpack_error_data </td><td class="fielddoc"><p >The contained data is not valid. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9d9f282ca4183ab5190e09d04c1f74c4a0b01d4850a0856cdf7a24bf22e3a5e14" name="gga9d9f282ca4183ab5190e09d04c1f74c4a0b01d4850a0856cdf7a24bf22e3a5e14"></a>mpack_error_eof </td><td class="fielddoc"><p >The reader failed to read because of file or socket EOF. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga22f03cf1240d5a917e1b3e7be8ab327e" name="ga22f03cf1240d5a917e1b3e7be8ab327e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga22f03cf1240d5a917e1b3e7be8ab327e">◆ </a></span>mpack_type_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Defines the type of a MessagePack tag. </p>
|
|
<p >Note that extension types, both user defined and built-in, are represented in tags as <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee">mpack_type_ext</a>. The value for an extension type is stored separately. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea0f53cbbeba7fd1b87394980b832c3fb9" name="gga22f03cf1240d5a917e1b3e7be8ab327ea0f53cbbeba7fd1b87394980b832c3fb9"></a>mpack_type_missing </td><td class="fielddoc"><p >Special type indicating a missing optional value. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327eaade66ddfcf1133c0ac00015ab26bd2b4" name="gga22f03cf1240d5a917e1b3e7be8ab327eaade66ddfcf1133c0ac00015ab26bd2b4"></a>mpack_type_nil </td><td class="fielddoc"><p >A null value. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea09eeb9595c0537ed4cdf2b11a4dd4d59" name="gga22f03cf1240d5a917e1b3e7be8ab327ea09eeb9595c0537ed4cdf2b11a4dd4d59"></a>mpack_type_bool </td><td class="fielddoc"><p >A boolean (true or false.) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e" name="gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e"></a>mpack_type_int </td><td class="fielddoc"><p >A 64-bit signed integer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654" name="gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654"></a>mpack_type_uint </td><td class="fielddoc"><p >A 64-bit unsigned integer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b" name="gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b"></a>mpack_type_float </td><td class="fielddoc"><p >A 32-bit IEEE 754 floating point number. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca" name="gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca"></a>mpack_type_double </td><td class="fielddoc"><p >A 64-bit IEEE 754 floating point number. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12" name="gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12"></a>mpack_type_str </td><td class="fielddoc"><p >A string. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6" name="gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6"></a>mpack_type_bin </td><td class="fielddoc"><p >A chunk of binary data. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327eabc1bfe5856870df99fa51a39923e6349" name="gga22f03cf1240d5a917e1b3e7be8ab327eabc1bfe5856870df99fa51a39923e6349"></a>mpack_type_array </td><td class="fielddoc"><p >An array of MessagePack objects. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea0cdc6eb2c069333405d0d23602f7006a" name="gga22f03cf1240d5a917e1b3e7be8ab327ea0cdc6eb2c069333405d0d23602f7006a"></a>mpack_type_map </td><td class="fielddoc"><p >An ordered map of key/value pairs of MessagePack objects. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee" name="gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee"></a>mpack_type_ext </td><td class="fielddoc"><p >A typed MessagePack extension object containing a chunk of binary data. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>. </dd></dl>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaba84f7d6b203a1f51f2a3e10c80318e2" name="gaba84f7d6b203a1f51f2a3e10c80318e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaba84f7d6b203a1f51f2a3e10c80318e2">◆ </a></span>mpack_version_t</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__common.html#gaba84f7d6b203a1f51f2a3e10c80318e2">mpack_version_t</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Versions of the MessagePack format. </p>
|
|
<p >A reader, writer, or tree can be configured to serialize in an older version of the MessagePack spec. This is necessary to interface with older MessagePack libraries that do not support new MessagePack features.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#ga3b7bc28af1393f6ab472f4595e29387b">MPACK_COMPATIBILITY</a>. </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaba84f7d6b203a1f51f2a3e10c80318e2a4f793c44ed56ffed4ea441cb47e2a41d" name="ggaba84f7d6b203a1f51f2a3e10c80318e2a4f793c44ed56ffed4ea441cb47e2a41d"></a>mpack_version_v4 </td><td class="fielddoc"><p >Version 1.0/v4, supporting only the <code>raw</code> type without <code>str8</code>. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaba84f7d6b203a1f51f2a3e10c80318e2aec7501edf20073ac35f31a66104f815e" name="ggaba84f7d6b203a1f51f2a3e10c80318e2aec7501edf20073ac35f31a66104f815e"></a>mpack_version_v5 </td><td class="fielddoc"><p >Version 2.0/v5, supporting the <code>str8</code>, <code>bin</code> and <code>ext</code> types. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaba84f7d6b203a1f51f2a3e10c80318e2a8c85d0a71537cbf52f57125bf6e55fcb" name="ggaba84f7d6b203a1f51f2a3e10c80318e2a8c85d0a71537cbf52f57125bf6e55fcb"></a>mpack_version_current </td><td class="fielddoc"><p >The most recent supported version of MessagePack. </p>
|
|
<p >This is the default. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gad2c776bf825722c9579f6003ad6ffe4b" name="gad2c776bf825722c9579f6003ad6ffe4b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad2c776bf825722c9579f6003ad6ffe4b">◆ </a></span>mpack_error_to_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * mpack_error_to_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga9d9f282ca4183ab5190e09d04c1f74c4">mpack_error_t</a> </td>
|
|
<td class="paramname"><em>error</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts an MPack error to a string. </p>
|
|
<p >This function returns an empty string when MPACK_DEBUG is not set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga31f7f337ff772a8e91af5e8394287ef4" name="ga31f7f337ff772a8e91af5e8394287ef4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga31f7f337ff772a8e91af5e8394287ef4">◆ </a></span>mpack_tag_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>count</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga6fbedd040803aebc19ed0ebab5965de3" title="Generates an array tag.">mpack_tag_make_array()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga071204c83da525e2925b4ba13e5eafa6" name="ga071204c83da525e2925b4ba13e5eafa6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga071204c83da525e2925b4ba13e5eafa6">◆ </a></span>mpack_tag_array_count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_array_count </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the number of elements in an array tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eabc1bfe5856870df99fa51a39923e6349">mpack_type_array</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eabc1bfe5856870df99fa51a39923e6349" title="An array of MessagePack objects.">mpack_type_array</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad193672644de9af88290b598ff8d2b8c" name="gad193672644de9af88290b598ff8d2b8c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad193672644de9af88290b598ff8d2b8c">◆ </a></span>mpack_tag_bin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_bin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>length</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga5a3c95acc8156125706dcf5ce05c59e0" title="Generates a bin tag.">mpack_tag_make_bin()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga658da0a45688be8ba6e22bab53784754" name="ga658da0a45688be8ba6e22bab53784754"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga658da0a45688be8ba6e22bab53784754">◆ </a></span>mpack_tag_bin_length()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_bin_length </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the length in bytes of a bin-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6">mpack_type_bin</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6" title="A chunk of binary data.">mpack_type_bin</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaafdb8f338605dfb8bf1e1edb6c07940e" name="gaafdb8f338605dfb8bf1e1edb6c07940e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaafdb8f338605dfb8bf1e1edb6c07940e">◆ </a></span>mpack_tag_bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_bool </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#gadc1fbc1c6d9440c886b31f4eaaa51e59" title="Generates a bool tag.">mpack_tag_make_bool()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8c0f7e30e7c3484ea96b8f154bbf72a1" name="ga8c0f7e30e7c3484ea96b8f154bbf72a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8c0f7e30e7c3484ea96b8f154bbf72a1">◆ </a></span>mpack_tag_bool_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool mpack_tag_bool_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the boolean value of a bool-type tag. </p>
|
|
<p >The tag must be of type <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea09eeb9595c0537ed4cdf2b11a4dd4d59">mpack_type_bool</a>.</p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea09eeb9595c0537ed4cdf2b11a4dd4d59">mpack_type_bool</a>. (No check is performed if MPACK_DEBUG is not set.) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga033c16708956cd2def6c81cbe6b39d21" name="ga033c16708956cd2def6c81cbe6b39d21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga033c16708956cd2def6c81cbe6b39d21">◆ </a></span>mpack_tag_bytes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_bytes </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the length in bytes of a str-, bin- or ext-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12">mpack_type_str</a>, <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6">mpack_type_bin</a> or <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee">mpack_type_ext</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12" title="A string.">mpack_type_str</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7b364aaa7af779777366ab36df2b3eb6" title="A chunk of binary data.">mpack_type_bin</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee" title="A typed MessagePack extension object containing a chunk of binary data.">mpack_type_ext</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga959a1299fde759b8fab2341cfb1355b8" name="ga959a1299fde759b8fab2341cfb1355b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga959a1299fde759b8fab2341cfb1355b8">◆ </a></span>mpack_tag_cmp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mpack_tag_cmp </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>left</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>right</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compares two tags with an arbitrary fixed ordering. </p>
|
|
<p >Returns 0 if the tags are equal, a negative integer if left comes before right, or a positive integer otherwise.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The ordering is not guaranteed to be preserved across MPack versions; do not rely on it in persistent data.</dd>
|
|
<dd>
|
|
Floating point numbers are compared bit-for-bit, not using the language's operator==. This means that NaNs with matching representation will compare equal. This behaviour is up for debate; see comments in the definition of <a class="el" href="group__common.html#ga959a1299fde759b8fab2341cfb1355b8" title="Compares two tags with an arbitrary fixed ordering.">mpack_tag_cmp()</a>.</dd></dl>
|
|
<p>See <a class="el" href="group__common.html#ga6278d8f1818309765fb7e30c14440b23" title="Compares two tags for equality.">mpack_tag_equal()</a> for more information on when tags are considered equal. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7451be24eeb32354af269a9071a14245" name="ga7451be24eeb32354af269a9071a14245"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7451be24eeb32354af269a9071a14245">◆ </a></span>mpack_tag_debug_describe()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mpack_tag_debug_describe </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>tag</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>buffer_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a debug string description of the given tag into the given buffer. </p>
|
|
<p >This is only available in debug mode, and only if stdio is available (since it uses snprintf().) It's strictly for debugging purposes. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gab7fb60017700ae126a0fe0fa3f3cadcb" name="gab7fb60017700ae126a0fe0fa3f3cadcb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gab7fb60017700ae126a0fe0fa3f3cadcb">◆ </a></span>mpack_tag_debug_pseudo_json()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mpack_tag_debug_pseudo_json </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>tag</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>buffer_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>prefix</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>prefix_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a json-like debug description of the given tag into the given buffer. </p>
|
|
<p >This is only available in debug mode, and only if stdio is available (since it uses snprintf().) It's strictly for debugging purposes.</p>
|
|
<p >The prefix is used to print the first few hexadecimal bytes of a bin or ext type. Pass NULL if not a bin or ext. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac9f0e0d6573ffafb1536ee6f02b742b6" name="gac9f0e0d6573ffafb1536ee6f02b742b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac9f0e0d6573ffafb1536ee6f02b742b6">◆ </a></span>mpack_tag_double()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_double </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga4efab5d78b1a5e8b39bee50e5ada3dd3" title="Generates a double tag.">mpack_tag_make_double()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga379fdaed101e1121d0be65a09fa6e5c0" name="ga379fdaed101e1121d0be65a09fa6e5c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga379fdaed101e1121d0be65a09fa6e5c0">◆ </a></span>mpack_tag_double_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double mpack_tag_double_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the double value of a double-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca">mpack_type_double</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This does not convert between float and double tags! This can only be used if the type is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca">mpack_type_double</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea46d1cf5028e3a0113be8edd73648a7ca" title="A 64-bit IEEE 754 floating point number.">mpack_type_double</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6278d8f1818309765fb7e30c14440b23" name="ga6278d8f1818309765fb7e30c14440b23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6278d8f1818309765fb7e30c14440b23">◆ </a></span>mpack_tag_equal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool mpack_tag_equal </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>left</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> </td>
|
|
<td class="paramname"><em>right</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compares two tags for equality. </p>
|
|
<p >Tags are considered equal if the types are compatible and the values (for non-compound types) are equal.</p>
|
|
<p >The field width of variable-width fields is ignored (and in fact is not stored in a tag), and positive numbers in signed integers are considered equal to their unsigned counterparts. So for example the value 1 stored as a positive fixint is equal to the value 1 stored in a 64-bit unsigned integer field.</p>
|
|
<p >The "extension type" of an extension object is considered part of the value and must match exactly.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Floating point numbers are compared bit-for-bit, not using the language's operator==. This means that NaNs with matching representation will compare equal. This behaviour is up for debate; see comments in the definition of <a class="el" href="group__common.html#ga959a1299fde759b8fab2341cfb1355b8" title="Compares two tags with an arbitrary fixed ordering.">mpack_tag_cmp()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa6c5f417a0c6e24d71965105b700dc90" name="gaa6c5f417a0c6e24d71965105b700dc90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa6c5f417a0c6e24d71965105b700dc90">◆ </a></span>mpack_tag_ext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_ext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>exttype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga5527a08e30b9e0b656804d144ab6ee32" title="Generates an ext tag.">mpack_tag_make_ext()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga65340d1eb1a2270c9f9618bb4ea8228d" name="ga65340d1eb1a2270c9f9618bb4ea8228d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga65340d1eb1a2270c9f9618bb4ea8228d">◆ </a></span>mpack_tag_ext_exttype()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int8_t mpack_tag_ext_exttype </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the extension type (exttype) of an ext-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee">mpack_type_ext</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee" title="A typed MessagePack extension object containing a chunk of binary data.">mpack_type_ext</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf68d677e5e05d08747703b9e7de122b5" name="gaf68d677e5e05d08747703b9e7de122b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf68d677e5e05d08747703b9e7de122b5">◆ </a></span>mpack_tag_ext_length()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_ext_length </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the length in bytes of an ext-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee">mpack_type_ext</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea7ccd85daa1ad40a83cc64484420510ee" title="A typed MessagePack extension object containing a chunk of binary data.">mpack_type_ext</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaaff6b2c99bc922aa51e138cc9b16717e" name="gaaff6b2c99bc922aa51e138cc9b16717e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaaff6b2c99bc922aa51e138cc9b16717e">◆ </a></span>mpack_tag_false()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_false </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga8808d78b72d2219c220482b7cfc41f38" title="Generates a bool tag with value false.">mpack_tag_make_false()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9323e7f5d3f615fcab945ff909fa5673" name="ga9323e7f5d3f615fcab945ff909fa5673"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9323e7f5d3f615fcab945ff909fa5673">◆ </a></span>mpack_tag_float()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga9c833cbf132df422350576d5b58050b1" title="Generates a float tag.">mpack_tag_make_float()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6013528247a4cb06928013cde4633814" name="ga6013528247a4cb06928013cde4633814"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6013528247a4cb06928013cde4633814">◆ </a></span>mpack_tag_float_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float mpack_tag_float_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the float value of a float-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b">mpack_type_float</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This does not convert between float and double tags! This can only be used if the type is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b">mpack_type_float</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab1614d2e0ffe43791a22db286b95d39b" title="A 32-bit IEEE 754 floating point number.">mpack_type_float</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga79fe4bddaffe6ebe8d97e362fe90ee5c" name="ga79fe4bddaffe6ebe8d97e362fe90ee5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga79fe4bddaffe6ebe8d97e362fe90ee5c">◆ </a></span>mpack_tag_int()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int64_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga7e1dd48858270d1be4491eeafeedc1e2" title="Generates a signed int tag.">mpack_tag_make_int()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gace2efaa8a795db3365f9a0deee4e3391" name="gace2efaa8a795db3365f9a0deee4e3391"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gace2efaa8a795db3365f9a0deee4e3391">◆ </a></span>mpack_tag_int_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t mpack_tag_int_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the signed integer value of an int-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e">mpack_type_int</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This does not convert between signed and unsigned tags! A positive integer may be stored in a tag as either <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e">mpack_type_int</a> or <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654">mpack_type_uint</a>. You must check the type first; this can only be used if the type is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e">mpack_type_int</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e" title="A 64-bit signed integer.">mpack_type_int</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6fbedd040803aebc19ed0ebab5965de3" name="ga6fbedd040803aebc19ed0ebab5965de3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6fbedd040803aebc19ed0ebab5965de3">◆ </a></span>mpack_tag_make_array()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>count</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates an array tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5a3c95acc8156125706dcf5ce05c59e0" name="ga5a3c95acc8156125706dcf5ce05c59e0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5a3c95acc8156125706dcf5ce05c59e0">◆ </a></span>mpack_tag_make_bin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_bin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a bin tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadc1fbc1c6d9440c886b31f4eaaa51e59" name="gadc1fbc1c6d9440c886b31f4eaaa51e59"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadc1fbc1c6d9440c886b31f4eaaa51e59">◆ </a></span>mpack_tag_make_bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_bool </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a bool tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4efab5d78b1a5e8b39bee50e5ada3dd3" name="ga4efab5d78b1a5e8b39bee50e5ada3dd3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4efab5d78b1a5e8b39bee50e5ada3dd3">◆ </a></span>mpack_tag_make_double()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_double </td>
|
|
<td>(</td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a double tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5527a08e30b9e0b656804d144ab6ee32" name="ga5527a08e30b9e0b656804d144ab6ee32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5527a08e30b9e0b656804d144ab6ee32">◆ </a></span>mpack_tag_make_ext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_ext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int8_t </td>
|
|
<td class="paramname"><em>exttype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates an ext tag. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This requires <a class="el" href="group__config.html#gab1d8587f6e314e491c7fdb262f0b2bd1">MPACK_EXTENSIONS</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8808d78b72d2219c220482b7cfc41f38" name="ga8808d78b72d2219c220482b7cfc41f38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8808d78b72d2219c220482b7cfc41f38">◆ </a></span>mpack_tag_make_false()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_false </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a bool tag with value false. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9c833cbf132df422350576d5b58050b1" name="ga9c833cbf132df422350576d5b58050b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9c833cbf132df422350576d5b58050b1">◆ </a></span>mpack_tag_make_float()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a float tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7e1dd48858270d1be4491eeafeedc1e2" name="ga7e1dd48858270d1be4491eeafeedc1e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7e1dd48858270d1be4491eeafeedc1e2">◆ </a></span>mpack_tag_make_int()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int64_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a signed int tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8c36771143fb793e5417934a5491f3cb" name="ga8c36771143fb793e5417934a5491f3cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8c36771143fb793e5417934a5491f3cb">◆ </a></span>mpack_tag_make_map()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_map </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>count</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a map tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga651e566bbe864d430b7fc76e08c6744d" name="ga651e566bbe864d430b7fc76e08c6744d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga651e566bbe864d430b7fc76e08c6744d">◆ </a></span>mpack_tag_make_nil()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_nil </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a nil tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6c01251057f6e6c68fee26ffdd339cf0" name="ga6c01251057f6e6c68fee26ffdd339cf0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6c01251057f6e6c68fee26ffdd339cf0">◆ </a></span>mpack_tag_make_str()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_str </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>length</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a str tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaee3b842534d3a83a6e4df02073559db0" name="gaee3b842534d3a83a6e4df02073559db0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaee3b842534d3a83a6e4df02073559db0">◆ </a></span>mpack_tag_make_true()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_true </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates a bool tag with value true. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4848b8753b0325d5d7f1f7f46cea8b63" name="ga4848b8753b0325d5d7f1f7f46cea8b63"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4848b8753b0325d5d7f1f7f46cea8b63">◆ </a></span>mpack_tag_make_uint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_make_uint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates an unsigned int tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9d0c0c98bad176e48b23878a7b1eae4f" name="ga9d0c0c98bad176e48b23878a7b1eae4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9d0c0c98bad176e48b23878a7b1eae4f">◆ </a></span>mpack_tag_map()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_map </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>count</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga8c36771143fb793e5417934a5491f3cb" title="Generates a map tag.">mpack_tag_make_map()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6fbba834bc069a6973738e00a6106c56" name="ga6fbba834bc069a6973738e00a6106c56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6fbba834bc069a6973738e00a6106c56">◆ </a></span>mpack_tag_map_count()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_map_count </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the number of key-value pairs in a map tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea0cdc6eb2c069333405d0d23602f7006a">mpack_type_map</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea0cdc6eb2c069333405d0d23602f7006a" title="An ordered map of key/value pairs of MessagePack objects.">mpack_type_map</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7dddc1921b402cd058bd32099db02fd0" name="ga7dddc1921b402cd058bd32099db02fd0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7dddc1921b402cd058bd32099db02fd0">◆ </a></span>mpack_tag_nil()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_nil </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga651e566bbe864d430b7fc76e08c6744d" title="Generates a nil tag.">mpack_tag_make_nil()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga583cda927620b566cbd7b75df0555ea6" name="ga583cda927620b566cbd7b75df0555ea6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga583cda927620b566cbd7b75df0555ea6">◆ </a></span>mpack_tag_str()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_str </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>length</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga6c01251057f6e6c68fee26ffdd339cf0" title="Generates a str tag.">mpack_tag_make_str()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6a8dc7f85c6673b68454e2ca38c07a5a" name="ga6a8dc7f85c6673b68454e2ca38c07a5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6a8dc7f85c6673b68454e2ca38c07a5a">◆ </a></span>mpack_tag_str_length()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mpack_tag_str_length </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the length in bytes of a str-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12">mpack_type_str</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327ea1e84e3b33ffa7dfc3bde110bd9455d12" title="A string.">mpack_type_str</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9408e69df94e21714579edfc95736006" name="ga9408e69df94e21714579edfc95736006"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9408e69df94e21714579edfc95736006">◆ </a></span>mpack_tag_true()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_true </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#gaee3b842534d3a83a6e4df02073559db0" title="Generates a bool tag with value true.">mpack_tag_make_true()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf3c75dc78631727344e154b82a73d37a" name="gaf3c75dc78631727344e154b82a73d37a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf3c75dc78631727344e154b82a73d37a">◆ </a></span>mpack_tag_type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a> mpack_tag_type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the type of a tag. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae3e808c63fa0ba040429f955249791d2" name="gae3e808c63fa0ba040429f955249791d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae3e808c63fa0ba040429f955249791d2">◆ </a></span>mpack_tag_uint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> mpack_tag_uint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>value</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Renamed to <a class="el" href="group__common.html#ga4848b8753b0325d5d7f1f7f46cea8b63" title="Generates an unsigned int tag.">mpack_tag_make_uint()</a>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaec6577f0333c2a7775c5e78757fe89f8" name="gaec6577f0333c2a7775c5e78757fe89f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaec6577f0333c2a7775c5e78757fe89f8">◆ </a></span>mpack_tag_uint_value()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t mpack_tag_uint_value </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga008da69ac6b5582a893f2d2ffd37f4ac">mpack_tag_t</a> * </td>
|
|
<td class="paramname"><em>tag</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the unsigned integer value of a uint-type tag. </p>
|
|
<p >This asserts that the type in the tag is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654">mpack_type_uint</a>. (No check is performed if MPACK_DEBUG is not set.)</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>This does not convert between signed and unsigned tags! A positive integer may be stored in a tag as either <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eab3ad5f31d28f4102ec5b9eee498f186e">mpack_type_int</a> or <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654">mpack_type_uint</a>. You must check the type first; this can only be used if the type is <a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654">mpack_type_uint</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__common.html#gga22f03cf1240d5a917e1b3e7be8ab327eae163adb67a277a223bbfe62ff3d42654" title="A 64-bit unsigned integer.">mpack_type_uint</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6d3ec73b8a671b7d4dd8e3d5670ff058" name="ga6d3ec73b8a671b7d4dd8e3d5670ff058"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6d3ec73b8a671b7d4dd8e3d5670ff058">◆ </a></span>mpack_type_to_string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * mpack_type_to_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__common.html#ga22f03cf1240d5a917e1b3e7be8ab327e">mpack_type_t</a> </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts an MPack type to a string. </p>
|
|
<p >This function returns an empty string when MPACK_DEBUG is not set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</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.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|