1*5dd36a3bSchristos<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2*5dd36a3bSchristos<html xmlns="http://www.w3.org/1999/xhtml"> 3*5dd36a3bSchristos<head> 4*5dd36a3bSchristos<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5*5dd36a3bSchristos<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6*5dd36a3bSchristos<meta name="generator" content="Doxygen 1.8.12"/> 7*5dd36a3bSchristos<meta name="viewport" content="width=device-width, initial-scale=1"/> 8*5dd36a3bSchristos<title>libcbor: src/cbor/maps.h File Reference</title> 9*5dd36a3bSchristos<link href="tabs.css" rel="stylesheet" type="text/css"/> 10*5dd36a3bSchristos<script type="text/javascript" src="jquery.js"></script> 11*5dd36a3bSchristos<script type="text/javascript" src="dynsections.js"></script> 12*5dd36a3bSchristos<link href="search/search.css" rel="stylesheet" type="text/css"/> 13*5dd36a3bSchristos<script type="text/javascript" src="search/searchdata.js"></script> 14*5dd36a3bSchristos<script type="text/javascript" src="search/search.js"></script> 15*5dd36a3bSchristos<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16*5dd36a3bSchristos<link href="customdoxygen.css" rel="stylesheet" type="text/css"/> 17*5dd36a3bSchristos</head> 18*5dd36a3bSchristos<body> 19*5dd36a3bSchristos<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 20*5dd36a3bSchristos<div id="titlearea"> 21*5dd36a3bSchristos<table cellspacing="0" cellpadding="0"> 22*5dd36a3bSchristos <tbody> 23*5dd36a3bSchristos <tr style="height: 56px;"> 24*5dd36a3bSchristos <td id="projectalign" style="padding-left: 0.5em;"> 25*5dd36a3bSchristos <div id="projectname">libcbor 26*5dd36a3bSchristos  <span id="projectnumber">0.5.0</span> 27*5dd36a3bSchristos </div> 28*5dd36a3bSchristos <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div> 29*5dd36a3bSchristos </td> 30*5dd36a3bSchristos </tr> 31*5dd36a3bSchristos </tbody> 32*5dd36a3bSchristos</table> 33*5dd36a3bSchristos</div> 34*5dd36a3bSchristos<!-- end header part --> 35*5dd36a3bSchristos<!-- Generated by Doxygen 1.8.12 --> 36*5dd36a3bSchristos<script type="text/javascript"> 37*5dd36a3bSchristosvar searchBox = new SearchBox("searchBox", "search",false,'Search'); 38*5dd36a3bSchristos</script> 39*5dd36a3bSchristos<script type="text/javascript" src="menudata.js"></script> 40*5dd36a3bSchristos<script type="text/javascript" src="menu.js"></script> 41*5dd36a3bSchristos<script type="text/javascript"> 42*5dd36a3bSchristos$(function() { 43*5dd36a3bSchristos initMenu('',true,false,'search.php','Search'); 44*5dd36a3bSchristos $(document).ready(function() { init_search(); }); 45*5dd36a3bSchristos}); 46*5dd36a3bSchristos</script> 47*5dd36a3bSchristos<div id="main-nav"></div> 48*5dd36a3bSchristos<!-- window showing the filter options --> 49*5dd36a3bSchristos<div id="MSearchSelectWindow" 50*5dd36a3bSchristos onmouseover="return searchBox.OnSearchSelectShow()" 51*5dd36a3bSchristos onmouseout="return searchBox.OnSearchSelectHide()" 52*5dd36a3bSchristos onkeydown="return searchBox.OnSearchSelectKey(event)"> 53*5dd36a3bSchristos</div> 54*5dd36a3bSchristos 55*5dd36a3bSchristos<!-- iframe showing the search results (closed by default) --> 56*5dd36a3bSchristos<div id="MSearchResultsWindow"> 57*5dd36a3bSchristos<iframe src="javascript:void(0)" frameborder="0" 58*5dd36a3bSchristos name="MSearchResults" id="MSearchResults"> 59*5dd36a3bSchristos</iframe> 60*5dd36a3bSchristos</div> 61*5dd36a3bSchristos 62*5dd36a3bSchristos<div id="nav-path" class="navpath"> 63*5dd36a3bSchristos <ul> 64*5dd36a3bSchristos<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cb565ba51d82ea933604984cbab6233d.html">cbor</a></li> </ul> 65*5dd36a3bSchristos</div> 66*5dd36a3bSchristos</div><!-- top --> 67*5dd36a3bSchristos<div class="header"> 68*5dd36a3bSchristos <div class="summary"> 69*5dd36a3bSchristos<a href="#func-members">Functions</a> </div> 70*5dd36a3bSchristos <div class="headertitle"> 71*5dd36a3bSchristos<div class="title">maps.h File Reference</div> </div> 72*5dd36a3bSchristos</div><!--header--> 73*5dd36a3bSchristos<div class="contents"> 74*5dd36a3bSchristos<div class="textblock"><code>#include "<a class="el" href="common_8h_source.html">cbor/common.h</a>"</code><br /> 75*5dd36a3bSchristos</div> 76*5dd36a3bSchristos<p><a href="maps_8h_source.html">Go to the source code of this file.</a></p> 77*5dd36a3bSchristos<table class="memberdecls"> 78*5dd36a3bSchristos<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 79*5dd36a3bSchristosFunctions</h2></td></tr> 80*5dd36a3bSchristos<tr class="memitem:a1bbbee9c6f1eaa0ff4c19559fe109baf"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a1bbbee9c6f1eaa0ff4c19559fe109baf">cbor_map_size</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 81*5dd36a3bSchristos<tr class="memdesc:a1bbbee9c6f1eaa0ff4c19559fe109baf"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of pairs. <a href="#a1bbbee9c6f1eaa0ff4c19559fe109baf">More...</a><br /></td></tr> 82*5dd36a3bSchristos<tr class="separator:a1bbbee9c6f1eaa0ff4c19559fe109baf"><td class="memSeparator" colspan="2"> </td></tr> 83*5dd36a3bSchristos<tr class="memitem:a3bf8e5779a3f1311b9b3f9e0a4e4f37e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a3bf8e5779a3f1311b9b3f9e0a4e4f37e">cbor_map_allocated</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 84*5dd36a3bSchristos<tr class="memdesc:a3bf8e5779a3f1311b9b3f9e0a4e4f37e"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the allocated storage. <a href="#a3bf8e5779a3f1311b9b3f9e0a4e4f37e">More...</a><br /></td></tr> 85*5dd36a3bSchristos<tr class="separator:a3bf8e5779a3f1311b9b3f9e0a4e4f37e"><td class="memSeparator" colspan="2"> </td></tr> 86*5dd36a3bSchristos<tr class="memitem:adab3c6ff2e51dcf2637567431cc6e76e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#adab3c6ff2e51dcf2637567431cc6e76e">cbor_new_definite_map</a> (size_t size)</td></tr> 87*5dd36a3bSchristos<tr class="memdesc:adab3c6ff2e51dcf2637567431cc6e76e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new definite map. <a href="#adab3c6ff2e51dcf2637567431cc6e76e">More...</a><br /></td></tr> 88*5dd36a3bSchristos<tr class="separator:adab3c6ff2e51dcf2637567431cc6e76e"><td class="memSeparator" colspan="2"> </td></tr> 89*5dd36a3bSchristos<tr class="memitem:a58ac69227f48815754651e93d15a5051"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a58ac69227f48815754651e93d15a5051">cbor_new_indefinite_map</a> ()</td></tr> 90*5dd36a3bSchristos<tr class="memdesc:a58ac69227f48815754651e93d15a5051"><td class="mdescLeft"> </td><td class="mdescRight">Create a new indefinite map. <a href="#a58ac69227f48815754651e93d15a5051">More...</a><br /></td></tr> 91*5dd36a3bSchristos<tr class="separator:a58ac69227f48815754651e93d15a5051"><td class="memSeparator" colspan="2"> </td></tr> 92*5dd36a3bSchristos<tr class="memitem:af077a30d8258ab02307c24af28036fca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#af077a30d8258ab02307c24af28036fca">cbor_map_add</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, struct <a class="el" href="structcbor__pair.html">cbor_pair</a> pair)</td></tr> 93*5dd36a3bSchristos<tr class="memdesc:af077a30d8258ab02307c24af28036fca"><td class="mdescLeft"> </td><td class="mdescRight">Add a pair to the map. <a href="#af077a30d8258ab02307c24af28036fca">More...</a><br /></td></tr> 94*5dd36a3bSchristos<tr class="separator:af077a30d8258ab02307c24af28036fca"><td class="memSeparator" colspan="2"> </td></tr> 95*5dd36a3bSchristos<tr class="memitem:a64c91e7ecba7cf7d0d4949153d681db8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a64c91e7ecba7cf7d0d4949153d681db8">_cbor_map_add_key</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *key)</td></tr> 96*5dd36a3bSchristos<tr class="memdesc:a64c91e7ecba7cf7d0d4949153d681db8"><td class="mdescLeft"> </td><td class="mdescRight">Add a key to the map. <a href="#a64c91e7ecba7cf7d0d4949153d681db8">More...</a><br /></td></tr> 97*5dd36a3bSchristos<tr class="separator:a64c91e7ecba7cf7d0d4949153d681db8"><td class="memSeparator" colspan="2"> </td></tr> 98*5dd36a3bSchristos<tr class="memitem:abb15486eebcd1c41c373613757505705"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#abb15486eebcd1c41c373613757505705">_cbor_map_add_value</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *value)</td></tr> 99*5dd36a3bSchristos<tr class="memdesc:abb15486eebcd1c41c373613757505705"><td class="mdescLeft"> </td><td class="mdescRight">Add a value to the map. <a href="#abb15486eebcd1c41c373613757505705">More...</a><br /></td></tr> 100*5dd36a3bSchristos<tr class="separator:abb15486eebcd1c41c373613757505705"><td class="memSeparator" colspan="2"> </td></tr> 101*5dd36a3bSchristos<tr class="memitem:a0dccaa76ac293bb5a11dbca6d16f6253"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a0dccaa76ac293bb5a11dbca6d16f6253">cbor_map_is_definite</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 102*5dd36a3bSchristos<tr class="memdesc:a0dccaa76ac293bb5a11dbca6d16f6253"><td class="mdescLeft"> </td><td class="mdescRight">Is this map definite? <a href="#a0dccaa76ac293bb5a11dbca6d16f6253">More...</a><br /></td></tr> 103*5dd36a3bSchristos<tr class="separator:a0dccaa76ac293bb5a11dbca6d16f6253"><td class="memSeparator" colspan="2"> </td></tr> 104*5dd36a3bSchristos<tr class="memitem:a941462383a3c8a6e3a60be9778cd1913"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a941462383a3c8a6e3a60be9778cd1913">cbor_map_is_indefinite</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 105*5dd36a3bSchristos<tr class="memdesc:a941462383a3c8a6e3a60be9778cd1913"><td class="mdescLeft"> </td><td class="mdescRight">Is this map indefinite? <a href="#a941462383a3c8a6e3a60be9778cd1913">More...</a><br /></td></tr> 106*5dd36a3bSchristos<tr class="separator:a941462383a3c8a6e3a60be9778cd1913"><td class="memSeparator" colspan="2"> </td></tr> 107*5dd36a3bSchristos<tr class="memitem:a4cadc8eb7ae7ff8d3f73482fb24455c9"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcbor__pair.html">cbor_pair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="maps_8h.html#a4cadc8eb7ae7ff8d3f73482fb24455c9">cbor_map_handle</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 108*5dd36a3bSchristos<tr class="memdesc:a4cadc8eb7ae7ff8d3f73482fb24455c9"><td class="mdescLeft"> </td><td class="mdescRight">Get the pairs storage. <a href="#a4cadc8eb7ae7ff8d3f73482fb24455c9">More...</a><br /></td></tr> 109*5dd36a3bSchristos<tr class="separator:a4cadc8eb7ae7ff8d3f73482fb24455c9"><td class="memSeparator" colspan="2"> </td></tr> 110*5dd36a3bSchristos</table> 111*5dd36a3bSchristos<h2 class="groupheader">Function Documentation</h2> 112*5dd36a3bSchristos<a id="a64c91e7ecba7cf7d0d4949153d681db8"></a> 113*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a64c91e7ecba7cf7d0d4949153d681db8">§ </a></span>_cbor_map_add_key()</h2> 114*5dd36a3bSchristos 115*5dd36a3bSchristos<div class="memitem"> 116*5dd36a3bSchristos<div class="memproto"> 117*5dd36a3bSchristos <table class="memname"> 118*5dd36a3bSchristos <tr> 119*5dd36a3bSchristos <td class="memname">bool _cbor_map_add_key </td> 120*5dd36a3bSchristos <td>(</td> 121*5dd36a3bSchristos <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 122*5dd36a3bSchristos <td class="paramname"><em>item</em>, </td> 123*5dd36a3bSchristos </tr> 124*5dd36a3bSchristos <tr> 125*5dd36a3bSchristos <td class="paramkey"></td> 126*5dd36a3bSchristos <td></td> 127*5dd36a3bSchristos <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 128*5dd36a3bSchristos <td class="paramname"><em>key</em> </td> 129*5dd36a3bSchristos </tr> 130*5dd36a3bSchristos <tr> 131*5dd36a3bSchristos <td></td> 132*5dd36a3bSchristos <td>)</td> 133*5dd36a3bSchristos <td></td><td></td> 134*5dd36a3bSchristos </tr> 135*5dd36a3bSchristos </table> 136*5dd36a3bSchristos</div><div class="memdoc"> 137*5dd36a3bSchristos 138*5dd36a3bSchristos<p>Add a key to the map. </p> 139*5dd36a3bSchristos<p>Sets the value to <code>NULL</code>. Internal API.</p> 140*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 141*5dd36a3bSchristos <table class="params"> 142*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 143*5dd36a3bSchristos <tr><td class="paramname">key[incref]</td><td>The key </td></tr> 144*5dd36a3bSchristos </table> 145*5dd36a3bSchristos </dd> 146*5dd36a3bSchristos</dl> 147*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> if either reallocation failed or the preallcoated storage is full </dd></dl> 148*5dd36a3bSchristos 149*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00066">66</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 150*5dd36a3bSchristos 151*5dd36a3bSchristos</div> 152*5dd36a3bSchristos</div> 153*5dd36a3bSchristos<a id="abb15486eebcd1c41c373613757505705"></a> 154*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#abb15486eebcd1c41c373613757505705">§ </a></span>_cbor_map_add_value()</h2> 155*5dd36a3bSchristos 156*5dd36a3bSchristos<div class="memitem"> 157*5dd36a3bSchristos<div class="memproto"> 158*5dd36a3bSchristos <table class="memname"> 159*5dd36a3bSchristos <tr> 160*5dd36a3bSchristos <td class="memname">bool _cbor_map_add_value </td> 161*5dd36a3bSchristos <td>(</td> 162*5dd36a3bSchristos <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 163*5dd36a3bSchristos <td class="paramname"><em>item</em>, </td> 164*5dd36a3bSchristos </tr> 165*5dd36a3bSchristos <tr> 166*5dd36a3bSchristos <td class="paramkey"></td> 167*5dd36a3bSchristos <td></td> 168*5dd36a3bSchristos <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 169*5dd36a3bSchristos <td class="paramname"><em>value</em> </td> 170*5dd36a3bSchristos </tr> 171*5dd36a3bSchristos <tr> 172*5dd36a3bSchristos <td></td> 173*5dd36a3bSchristos <td>)</td> 174*5dd36a3bSchristos <td></td><td></td> 175*5dd36a3bSchristos </tr> 176*5dd36a3bSchristos </table> 177*5dd36a3bSchristos</div><div class="memdoc"> 178*5dd36a3bSchristos 179*5dd36a3bSchristos<p>Add a value to the map. </p> 180*5dd36a3bSchristos<p>Assumes that <a class="el" href="maps_8h.html#a64c91e7ecba7cf7d0d4949153d681db8" title="Add a key to the map. ">_cbor_map_add_key</a> has been called. Internal API.</p> 181*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 182*5dd36a3bSchristos <table class="params"> 183*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 184*5dd36a3bSchristos <tr><td class="paramname">key[incref]</td><td>The value </td></tr> 185*5dd36a3bSchristos </table> 186*5dd36a3bSchristos </dd> 187*5dd36a3bSchristos</dl> 188*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> if either reallocation failed or the preallcoated storage is full </dd></dl> 189*5dd36a3bSchristos 190*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00106">106</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 191*5dd36a3bSchristos 192*5dd36a3bSchristos</div> 193*5dd36a3bSchristos</div> 194*5dd36a3bSchristos<a id="af077a30d8258ab02307c24af28036fca"></a> 195*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#af077a30d8258ab02307c24af28036fca">§ </a></span>cbor_map_add()</h2> 196*5dd36a3bSchristos 197*5dd36a3bSchristos<div class="memitem"> 198*5dd36a3bSchristos<div class="memproto"> 199*5dd36a3bSchristos <table class="memname"> 200*5dd36a3bSchristos <tr> 201*5dd36a3bSchristos <td class="memname">bool cbor_map_add </td> 202*5dd36a3bSchristos <td>(</td> 203*5dd36a3bSchristos <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 204*5dd36a3bSchristos <td class="paramname"><em>item</em>, </td> 205*5dd36a3bSchristos </tr> 206*5dd36a3bSchristos <tr> 207*5dd36a3bSchristos <td class="paramkey"></td> 208*5dd36a3bSchristos <td></td> 209*5dd36a3bSchristos <td class="paramtype">struct <a class="el" href="structcbor__pair.html">cbor_pair</a> </td> 210*5dd36a3bSchristos <td class="paramname"><em>pair</em> </td> 211*5dd36a3bSchristos </tr> 212*5dd36a3bSchristos <tr> 213*5dd36a3bSchristos <td></td> 214*5dd36a3bSchristos <td>)</td> 215*5dd36a3bSchristos <td></td><td></td> 216*5dd36a3bSchristos </tr> 217*5dd36a3bSchristos </table> 218*5dd36a3bSchristos</div><div class="memdoc"> 219*5dd36a3bSchristos 220*5dd36a3bSchristos<p>Add a pair to the map. </p> 221*5dd36a3bSchristos<p>For definite maps, items can only be added to the preallocated space. For indefinite maps, the storage will be expanded as needed</p> 222*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 223*5dd36a3bSchristos <table class="params"> 224*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 225*5dd36a3bSchristos <tr><td class="paramname">pair[incref]</td><td>The key-value pair to add (incref is member-wise) </td></tr> 226*5dd36a3bSchristos </table> 227*5dd36a3bSchristos </dd> 228*5dd36a3bSchristos</dl> 229*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> if either reallocation failed or the preallcoated storage is full </dd></dl> 230*5dd36a3bSchristos 231*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00118">118</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 232*5dd36a3bSchristos 233*5dd36a3bSchristos</div> 234*5dd36a3bSchristos</div> 235*5dd36a3bSchristos<a id="a3bf8e5779a3f1311b9b3f9e0a4e4f37e"></a> 236*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a3bf8e5779a3f1311b9b3f9e0a4e4f37e">§ </a></span>cbor_map_allocated()</h2> 237*5dd36a3bSchristos 238*5dd36a3bSchristos<div class="memitem"> 239*5dd36a3bSchristos<div class="memproto"> 240*5dd36a3bSchristos <table class="memname"> 241*5dd36a3bSchristos <tr> 242*5dd36a3bSchristos <td class="memname">size_t cbor_map_allocated </td> 243*5dd36a3bSchristos <td>(</td> 244*5dd36a3bSchristos <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 245*5dd36a3bSchristos <td class="paramname"><em>item</em></td><td>)</td> 246*5dd36a3bSchristos <td></td> 247*5dd36a3bSchristos </tr> 248*5dd36a3bSchristos </table> 249*5dd36a3bSchristos</div><div class="memdoc"> 250*5dd36a3bSchristos 251*5dd36a3bSchristos<p>Get the size of the allocated storage. </p> 252*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 253*5dd36a3bSchristos <table class="params"> 254*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 255*5dd36a3bSchristos </table> 256*5dd36a3bSchristos </dd> 257*5dd36a3bSchristos</dl> 258*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd>Allocated storage size (as the number of <a class="el" href="structcbor__pair.html" title="Simple pair of items for use in maps. ">cbor_pair</a> items) </dd></dl> 259*5dd36a3bSchristos 260*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00017">17</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 261*5dd36a3bSchristos 262*5dd36a3bSchristos</div> 263*5dd36a3bSchristos</div> 264*5dd36a3bSchristos<a id="a4cadc8eb7ae7ff8d3f73482fb24455c9"></a> 265*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a4cadc8eb7ae7ff8d3f73482fb24455c9">§ </a></span>cbor_map_handle()</h2> 266*5dd36a3bSchristos 267*5dd36a3bSchristos<div class="memitem"> 268*5dd36a3bSchristos<div class="memproto"> 269*5dd36a3bSchristos <table class="memname"> 270*5dd36a3bSchristos <tr> 271*5dd36a3bSchristos <td class="memname">struct <a class="el" href="structcbor__pair.html">cbor_pair</a>* cbor_map_handle </td> 272*5dd36a3bSchristos <td>(</td> 273*5dd36a3bSchristos <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 274*5dd36a3bSchristos <td class="paramname"><em>item</em></td><td>)</td> 275*5dd36a3bSchristos <td></td> 276*5dd36a3bSchristos </tr> 277*5dd36a3bSchristos </table> 278*5dd36a3bSchristos</div><div class="memdoc"> 279*5dd36a3bSchristos 280*5dd36a3bSchristos<p>Get the pairs storage. </p> 281*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 282*5dd36a3bSchristos <table class="params"> 283*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 284*5dd36a3bSchristos </table> 285*5dd36a3bSchristos </dd> 286*5dd36a3bSchristos</dl> 287*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd>Array of <a class="el" href="maps_8h.html#a1bbbee9c6f1eaa0ff4c19559fe109baf" title="Get the number of pairs. ">cbor_map_size</a> pairs. Manipulation is possible as long as references remain valid. </dd></dl> 288*5dd36a3bSchristos 289*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00137">137</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 290*5dd36a3bSchristos 291*5dd36a3bSchristos</div> 292*5dd36a3bSchristos</div> 293*5dd36a3bSchristos<a id="a0dccaa76ac293bb5a11dbca6d16f6253"></a> 294*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a0dccaa76ac293bb5a11dbca6d16f6253">§ </a></span>cbor_map_is_definite()</h2> 295*5dd36a3bSchristos 296*5dd36a3bSchristos<div class="memitem"> 297*5dd36a3bSchristos<div class="memproto"> 298*5dd36a3bSchristos <table class="memname"> 299*5dd36a3bSchristos <tr> 300*5dd36a3bSchristos <td class="memname">bool cbor_map_is_definite </td> 301*5dd36a3bSchristos <td>(</td> 302*5dd36a3bSchristos <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 303*5dd36a3bSchristos <td class="paramname"><em>item</em></td><td>)</td> 304*5dd36a3bSchristos <td></td> 305*5dd36a3bSchristos </tr> 306*5dd36a3bSchristos </table> 307*5dd36a3bSchristos</div><div class="memdoc"> 308*5dd36a3bSchristos 309*5dd36a3bSchristos<p>Is this map definite? </p> 310*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 311*5dd36a3bSchristos <table class="params"> 312*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 313*5dd36a3bSchristos </table> 314*5dd36a3bSchristos </dd> 315*5dd36a3bSchristos</dl> 316*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd>Is this map definite? </dd></dl> 317*5dd36a3bSchristos 318*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00126">126</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 319*5dd36a3bSchristos 320*5dd36a3bSchristos</div> 321*5dd36a3bSchristos</div> 322*5dd36a3bSchristos<a id="a941462383a3c8a6e3a60be9778cd1913"></a> 323*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a941462383a3c8a6e3a60be9778cd1913">§ </a></span>cbor_map_is_indefinite()</h2> 324*5dd36a3bSchristos 325*5dd36a3bSchristos<div class="memitem"> 326*5dd36a3bSchristos<div class="memproto"> 327*5dd36a3bSchristos <table class="memname"> 328*5dd36a3bSchristos <tr> 329*5dd36a3bSchristos <td class="memname">bool cbor_map_is_indefinite </td> 330*5dd36a3bSchristos <td>(</td> 331*5dd36a3bSchristos <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 332*5dd36a3bSchristos <td class="paramname"><em>item</em></td><td>)</td> 333*5dd36a3bSchristos <td></td> 334*5dd36a3bSchristos </tr> 335*5dd36a3bSchristos </table> 336*5dd36a3bSchristos</div><div class="memdoc"> 337*5dd36a3bSchristos 338*5dd36a3bSchristos<p>Is this map indefinite? </p> 339*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 340*5dd36a3bSchristos <table class="params"> 341*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 342*5dd36a3bSchristos </table> 343*5dd36a3bSchristos </dd> 344*5dd36a3bSchristos</dl> 345*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd>Is this map indefinite? </dd></dl> 346*5dd36a3bSchristos 347*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00132">132</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 348*5dd36a3bSchristos 349*5dd36a3bSchristos</div> 350*5dd36a3bSchristos</div> 351*5dd36a3bSchristos<a id="a1bbbee9c6f1eaa0ff4c19559fe109baf"></a> 352*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a1bbbee9c6f1eaa0ff4c19559fe109baf">§ </a></span>cbor_map_size()</h2> 353*5dd36a3bSchristos 354*5dd36a3bSchristos<div class="memitem"> 355*5dd36a3bSchristos<div class="memproto"> 356*5dd36a3bSchristos <table class="memname"> 357*5dd36a3bSchristos <tr> 358*5dd36a3bSchristos <td class="memname">size_t cbor_map_size </td> 359*5dd36a3bSchristos <td>(</td> 360*5dd36a3bSchristos <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 361*5dd36a3bSchristos <td class="paramname"><em>item</em></td><td>)</td> 362*5dd36a3bSchristos <td></td> 363*5dd36a3bSchristos </tr> 364*5dd36a3bSchristos </table> 365*5dd36a3bSchristos</div><div class="memdoc"> 366*5dd36a3bSchristos 367*5dd36a3bSchristos<p>Get the number of pairs. </p> 368*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 369*5dd36a3bSchristos <table class="params"> 370*5dd36a3bSchristos <tr><td class="paramname">item[borrow]</td><td>A map </td></tr> 371*5dd36a3bSchristos </table> 372*5dd36a3bSchristos </dd> 373*5dd36a3bSchristos</dl> 374*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd>The number of pairs </dd></dl> 375*5dd36a3bSchristos 376*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00011">11</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 377*5dd36a3bSchristos 378*5dd36a3bSchristos</div> 379*5dd36a3bSchristos</div> 380*5dd36a3bSchristos<a id="adab3c6ff2e51dcf2637567431cc6e76e"></a> 381*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#adab3c6ff2e51dcf2637567431cc6e76e">§ </a></span>cbor_new_definite_map()</h2> 382*5dd36a3bSchristos 383*5dd36a3bSchristos<div class="memitem"> 384*5dd36a3bSchristos<div class="memproto"> 385*5dd36a3bSchristos <table class="memname"> 386*5dd36a3bSchristos <tr> 387*5dd36a3bSchristos <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_new_definite_map </td> 388*5dd36a3bSchristos <td>(</td> 389*5dd36a3bSchristos <td class="paramtype">size_t </td> 390*5dd36a3bSchristos <td class="paramname"><em>size</em></td><td>)</td> 391*5dd36a3bSchristos <td></td> 392*5dd36a3bSchristos </tr> 393*5dd36a3bSchristos </table> 394*5dd36a3bSchristos</div><div class="memdoc"> 395*5dd36a3bSchristos 396*5dd36a3bSchristos<p>Create a new definite map. </p> 397*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 398*5dd36a3bSchristos <table class="params"> 399*5dd36a3bSchristos <tr><td class="paramname">size</td><td>The number of slots to preallocate </td></tr> 400*5dd36a3bSchristos </table> 401*5dd36a3bSchristos </dd> 402*5dd36a3bSchristos</dl> 403*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd><b>new</b> definite map. <code>NULL</code> on malloc failure. </dd></dl> 404*5dd36a3bSchristos 405*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00023">23</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 406*5dd36a3bSchristos 407*5dd36a3bSchristos</div> 408*5dd36a3bSchristos</div> 409*5dd36a3bSchristos<a id="a58ac69227f48815754651e93d15a5051"></a> 410*5dd36a3bSchristos<h2 class="memtitle"><span class="permalink"><a href="#a58ac69227f48815754651e93d15a5051">§ </a></span>cbor_new_indefinite_map()</h2> 411*5dd36a3bSchristos 412*5dd36a3bSchristos<div class="memitem"> 413*5dd36a3bSchristos<div class="memproto"> 414*5dd36a3bSchristos <table class="memname"> 415*5dd36a3bSchristos <tr> 416*5dd36a3bSchristos <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_new_indefinite_map </td> 417*5dd36a3bSchristos <td>(</td> 418*5dd36a3bSchristos <td class="paramname"></td><td>)</td> 419*5dd36a3bSchristos <td></td> 420*5dd36a3bSchristos </tr> 421*5dd36a3bSchristos </table> 422*5dd36a3bSchristos</div><div class="memdoc"> 423*5dd36a3bSchristos 424*5dd36a3bSchristos<p>Create a new indefinite map. </p> 425*5dd36a3bSchristos<dl class="params"><dt>Parameters</dt><dd> 426*5dd36a3bSchristos <table class="params"> 427*5dd36a3bSchristos <tr><td class="paramname">size</td><td>The number of slots to preallocate </td></tr> 428*5dd36a3bSchristos </table> 429*5dd36a3bSchristos </dd> 430*5dd36a3bSchristos</dl> 431*5dd36a3bSchristos<dl class="section return"><dt>Returns</dt><dd><b>new</b> definite map. <code>NULL</code> on malloc failure. </dd></dl> 432*5dd36a3bSchristos 433*5dd36a3bSchristos<p>Definition at line <a class="el" href="maps_8c_source.html#l00046">46</a> of file <a class="el" href="maps_8c_source.html">maps.c</a>.</p> 434*5dd36a3bSchristos 435*5dd36a3bSchristos</div> 436*5dd36a3bSchristos</div> 437*5dd36a3bSchristos</div><!-- contents --> 438*5dd36a3bSchristos<!-- start footer part --> 439*5dd36a3bSchristos<hr class="footer"/><address class="footer"><small> 440*5dd36a3bSchristosGenerated on Mon Feb 6 2017 00:26:19 for libcbor by  <a href="http://www.doxygen.org/index.html"> 441*5dd36a3bSchristos<img class="footer" src="doxygen.png" alt="doxygen"/> 442*5dd36a3bSchristos</a> 1.8.12 443*5dd36a3bSchristos</small></address> 444*5dd36a3bSchristos</body> 445*5dd36a3bSchristos</html> 446
