xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/arrays_8h.html (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.12"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>libcbor: src/cbor/arrays.h File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24  <td id="projectalign" style="padding-left: 0.5em;">
25   <div id="projectname">libcbor
26   &#160;<span id="projectnumber">0.5.0</span>
27   </div>
28   <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div>
29  </td>
30 </tr>
31 </tbody>
32</table>
33</div>
34<!-- end header part -->
35<!-- Generated by Doxygen 1.8.12 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
39<script type="text/javascript" src="menudata.js"></script>
40<script type="text/javascript" src="menu.js"></script>
41<script type="text/javascript">
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46</script>
47<div id="main-nav"></div>
48<!-- window showing the filter options -->
49<div id="MSearchSelectWindow"
50     onmouseover="return searchBox.OnSearchSelectShow()"
51     onmouseout="return searchBox.OnSearchSelectHide()"
52     onkeydown="return searchBox.OnSearchSelectKey(event)">
53</div>
54
55<!-- iframe showing the search results (closed by default) -->
56<div id="MSearchResultsWindow">
57<iframe src="javascript:void(0)" frameborder="0"
58        name="MSearchResults" id="MSearchResults">
59</iframe>
60</div>
61
62<div id="nav-path" class="navpath">
63  <ul>
64<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</div>
66</div><!-- top -->
67<div class="header">
68  <div class="summary">
69<a href="#func-members">Functions</a>  </div>
70  <div class="headertitle">
71<div class="title">arrays.h File Reference</div>  </div>
72</div><!--header-->
73<div class="contents">
74<div class="textblock"><code>#include &quot;<a class="el" href="common_8h_source.html">cbor/common.h</a>&quot;</code><br />
75</div>
76<p><a href="arrays_8h_source.html">Go to the source code of this file.</a></p>
77<table class="memberdecls">
78<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
79Functions</h2></td></tr>
80<tr class="memitem:a4f634a9a4bc834e4ea6ac43e94d51f84"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a4f634a9a4bc834e4ea6ac43e94d51f84">cbor_array_size</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
81<tr class="memdesc:a4f634a9a4bc834e4ea6ac43e94d51f84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of members.  <a href="#a4f634a9a4bc834e4ea6ac43e94d51f84">More...</a><br /></td></tr>
82<tr class="separator:a4f634a9a4bc834e4ea6ac43e94d51f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
83<tr class="memitem:a5da97cca271f81f55809c39fad6078b0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a5da97cca271f81f55809c39fad6078b0">cbor_array_allocated</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
84<tr class="memdesc:a5da97cca271f81f55809c39fad6078b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the allocated storage.  <a href="#a5da97cca271f81f55809c39fad6078b0">More...</a><br /></td></tr>
85<tr class="separator:a5da97cca271f81f55809c39fad6078b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
86<tr class="memitem:a1573139e26cf5b5acc4b0ed861291069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a1573139e26cf5b5acc4b0ed861291069">cbor_array_get</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, size_t index)</td></tr>
87<tr class="memdesc:a1573139e26cf5b5acc4b0ed861291069"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get item by index.  <a href="#a1573139e26cf5b5acc4b0ed861291069">More...</a><br /></td></tr>
88<tr class="separator:a1573139e26cf5b5acc4b0ed861291069"><td class="memSeparator" colspan="2">&#160;</td></tr>
89<tr class="memitem:a382cc2dc480ebb9c7951eb3235be89b4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a382cc2dc480ebb9c7951eb3235be89b4">cbor_array_set</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, size_t index, <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *value)</td></tr>
90<tr class="memdesc:a382cc2dc480ebb9c7951eb3235be89b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set item by index.  <a href="#a382cc2dc480ebb9c7951eb3235be89b4">More...</a><br /></td></tr>
91<tr class="separator:a382cc2dc480ebb9c7951eb3235be89b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<tr class="memitem:a44020515090bbbe91249aff0016ab8e5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a44020515090bbbe91249aff0016ab8e5">cbor_array_replace</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, size_t index, <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *value)</td></tr>
93<tr class="memdesc:a44020515090bbbe91249aff0016ab8e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace item at an index.  <a href="#a44020515090bbbe91249aff0016ab8e5">More...</a><br /></td></tr>
94<tr class="separator:a44020515090bbbe91249aff0016ab8e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<tr class="memitem:ac2f1480c546a0268e8b046b365e58599"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#ac2f1480c546a0268e8b046b365e58599">cbor_array_is_definite</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
96<tr class="memdesc:ac2f1480c546a0268e8b046b365e58599"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the array definite?  <a href="#ac2f1480c546a0268e8b046b365e58599">More...</a><br /></td></tr>
97<tr class="separator:ac2f1480c546a0268e8b046b365e58599"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:a291a9f3ff12a2e2c58b2ca8b00280d40"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a291a9f3ff12a2e2c58b2ca8b00280d40">cbor_array_is_indefinite</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
99<tr class="memdesc:a291a9f3ff12a2e2c58b2ca8b00280d40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the array indefinite?  <a href="#a291a9f3ff12a2e2c58b2ca8b00280d40">More...</a><br /></td></tr>
100<tr class="separator:a291a9f3ff12a2e2c58b2ca8b00280d40"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:a8dd01f4a46f162fa4f06b7df7428128e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a8dd01f4a46f162fa4f06b7df7428128e">cbor_array_handle</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
102<tr class="memdesc:a8dd01f4a46f162fa4f06b7df7428128e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the array contents.  <a href="#a8dd01f4a46f162fa4f06b7df7428128e">More...</a><br /></td></tr>
103<tr class="separator:a8dd01f4a46f162fa4f06b7df7428128e"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<tr class="memitem:a93d7c18019000d5e206a81a4cca70631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#a93d7c18019000d5e206a81a4cca70631">cbor_new_definite_array</a> (size_t size)</td></tr>
105<tr class="memdesc:a93d7c18019000d5e206a81a4cca70631"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new definite array.  <a href="#a93d7c18019000d5e206a81a4cca70631">More...</a><br /></td></tr>
106<tr class="separator:a93d7c18019000d5e206a81a4cca70631"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:aaec916ccc6f19782b6aef5ec1da2cc26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#aaec916ccc6f19782b6aef5ec1da2cc26">cbor_new_indefinite_array</a> ()</td></tr>
108<tr class="memdesc:aaec916ccc6f19782b6aef5ec1da2cc26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new indefinite array.  <a href="#aaec916ccc6f19782b6aef5ec1da2cc26">More...</a><br /></td></tr>
109<tr class="separator:aaec916ccc6f19782b6aef5ec1da2cc26"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:abb1c1c9731a2195857dc471f2a6f60f5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="arrays_8h.html#abb1c1c9731a2195857dc471f2a6f60f5">cbor_array_push</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *array, <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *pushee)</td></tr>
111<tr class="memdesc:abb1c1c9731a2195857dc471f2a6f60f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append to the end.  <a href="#abb1c1c9731a2195857dc471f2a6f60f5">More...</a><br /></td></tr>
112<tr class="separator:abb1c1c9731a2195857dc471f2a6f60f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
113</table>
114<h2 class="groupheader">Function Documentation</h2>
115<a id="a5da97cca271f81f55809c39fad6078b0"></a>
116<h2 class="memtitle"><span class="permalink"><a href="#a5da97cca271f81f55809c39fad6078b0">&sect;&nbsp;</a></span>cbor_array_allocated()</h2>
117
118<div class="memitem">
119<div class="memproto">
120      <table class="memname">
121        <tr>
122          <td class="memname">size_t cbor_array_allocated </td>
123          <td>(</td>
124          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
125          <td class="paramname"><em>item</em></td><td>)</td>
126          <td></td>
127        </tr>
128      </table>
129</div><div class="memdoc">
130
131<p>Get the size of the allocated storage. </p>
132<dl class="params"><dt>Parameters</dt><dd>
133  <table class="params">
134    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
135  </table>
136  </dd>
137</dl>
138<dl class="section return"><dt>Returns</dt><dd>The size of the allocated storage (number of items) </dd></dl>
139
140<p>Definition at line <a class="el" href="arrays_8c_source.html#l00018">18</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
141
142</div>
143</div>
144<a id="a1573139e26cf5b5acc4b0ed861291069"></a>
145<h2 class="memtitle"><span class="permalink"><a href="#a1573139e26cf5b5acc4b0ed861291069">&sect;&nbsp;</a></span>cbor_array_get()</h2>
146
147<div class="memitem">
148<div class="memproto">
149      <table class="memname">
150        <tr>
151          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_array_get </td>
152          <td>(</td>
153          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
154          <td class="paramname"><em>item</em>, </td>
155        </tr>
156        <tr>
157          <td class="paramkey"></td>
158          <td></td>
159          <td class="paramtype">size_t&#160;</td>
160          <td class="paramname"><em>index</em>&#160;</td>
161        </tr>
162        <tr>
163          <td></td>
164          <td>)</td>
165          <td></td><td></td>
166        </tr>
167      </table>
168</div><div class="memdoc">
169
170<p>Get item by index. </p>
171<dl class="params"><dt>Parameters</dt><dd>
172  <table class="params">
173    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
174    <tr><td class="paramname">index</td><td>The index </td></tr>
175  </table>
176  </dd>
177</dl>
178<dl class="section return"><dt>Returns</dt><dd><b>incref</b> The item, or <code>NULL</code> in case of boundary violation </dd></dl>
179
180<p>Definition at line <a class="el" href="arrays_8c_source.html#l00025">25</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
181
182</div>
183</div>
184<a id="a8dd01f4a46f162fa4f06b7df7428128e"></a>
185<h2 class="memtitle"><span class="permalink"><a href="#a8dd01f4a46f162fa4f06b7df7428128e">&sect;&nbsp;</a></span>cbor_array_handle()</h2>
186
187<div class="memitem">
188<div class="memproto">
189      <table class="memname">
190        <tr>
191          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>** cbor_array_handle </td>
192          <td>(</td>
193          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
194          <td class="paramname"><em>item</em></td><td>)</td>
195          <td></td>
196        </tr>
197      </table>
198</div><div class="memdoc">
199
200<p>Get the array contents. </p>
201<p>The items may be reordered and modified as long as references remain consistent.</p>
202<dl class="params"><dt>Parameters</dt><dd>
203  <table class="params">
204    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
205  </table>
206  </dd>
207</dl>
208<dl class="section return"><dt>Returns</dt><dd><a class="el" href="arrays_8h.html#a4f634a9a4bc834e4ea6ac43e94d51f84" title="Get the number of members. ">cbor_array_size</a> items </dd></dl>
209
210<p>Definition at line <a class="el" href="arrays_8c_source.html#l00100">100</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
211
212</div>
213</div>
214<a id="ac2f1480c546a0268e8b046b365e58599"></a>
215<h2 class="memtitle"><span class="permalink"><a href="#ac2f1480c546a0268e8b046b365e58599">&sect;&nbsp;</a></span>cbor_array_is_definite()</h2>
216
217<div class="memitem">
218<div class="memproto">
219      <table class="memname">
220        <tr>
221          <td class="memname">bool cbor_array_is_definite </td>
222          <td>(</td>
223          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
224          <td class="paramname"><em>item</em></td><td>)</td>
225          <td></td>
226        </tr>
227      </table>
228</div><div class="memdoc">
229
230<p>Is the array definite? </p>
231<dl class="params"><dt>Parameters</dt><dd>
232  <table class="params">
233    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
234  </table>
235  </dd>
236</dl>
237<dl class="section return"><dt>Returns</dt><dd>Is the array definite? </dd></dl>
238
239<p>Definition at line <a class="el" href="arrays_8c_source.html#l00088">88</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
240
241</div>
242</div>
243<a id="a291a9f3ff12a2e2c58b2ca8b00280d40"></a>
244<h2 class="memtitle"><span class="permalink"><a href="#a291a9f3ff12a2e2c58b2ca8b00280d40">&sect;&nbsp;</a></span>cbor_array_is_indefinite()</h2>
245
246<div class="memitem">
247<div class="memproto">
248      <table class="memname">
249        <tr>
250          <td class="memname">bool cbor_array_is_indefinite </td>
251          <td>(</td>
252          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
253          <td class="paramname"><em>item</em></td><td>)</td>
254          <td></td>
255        </tr>
256      </table>
257</div><div class="memdoc">
258
259<p>Is the array indefinite? </p>
260<dl class="params"><dt>Parameters</dt><dd>
261  <table class="params">
262    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
263  </table>
264  </dd>
265</dl>
266<dl class="section return"><dt>Returns</dt><dd>Is the array indefinite? </dd></dl>
267
268<p>Definition at line <a class="el" href="arrays_8c_source.html#l00094">94</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
269
270</div>
271</div>
272<a id="abb1c1c9731a2195857dc471f2a6f60f5"></a>
273<h2 class="memtitle"><span class="permalink"><a href="#abb1c1c9731a2195857dc471f2a6f60f5">&sect;&nbsp;</a></span>cbor_array_push()</h2>
274
275<div class="memitem">
276<div class="memproto">
277      <table class="memname">
278        <tr>
279          <td class="memname">bool cbor_array_push </td>
280          <td>(</td>
281          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
282          <td class="paramname"><em>array</em>, </td>
283        </tr>
284        <tr>
285          <td class="paramkey"></td>
286          <td></td>
287          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
288          <td class="paramname"><em>pushee</em>&#160;</td>
289        </tr>
290        <tr>
291          <td></td>
292          <td>)</td>
293          <td></td><td></td>
294        </tr>
295      </table>
296</div><div class="memdoc">
297
298<p>Append to the end. </p>
299<p>For indefinite items, storage may be realloacted. For definite items, only the preallocated capacity is available.</p>
300<dl class="params"><dt>Parameters</dt><dd>
301  <table class="params">
302    <tr><td class="paramname">array[borrow]</td><td>An array </td></tr>
303    <tr><td class="paramname">pushee[incref]</td><td>The item to push </td></tr>
304  </table>
305  </dd>
306</dl>
307<dl class="section return"><dt>Returns</dt><dd>true on success, false on failure </dd></dl>
308
309<p>Definition at line <a class="el" href="arrays_8c_source.html#l00052">52</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
310
311</div>
312</div>
313<a id="a44020515090bbbe91249aff0016ab8e5"></a>
314<h2 class="memtitle"><span class="permalink"><a href="#a44020515090bbbe91249aff0016ab8e5">&sect;&nbsp;</a></span>cbor_array_replace()</h2>
315
316<div class="memitem">
317<div class="memproto">
318      <table class="memname">
319        <tr>
320          <td class="memname">bool cbor_array_replace </td>
321          <td>(</td>
322          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
323          <td class="paramname"><em>item</em>, </td>
324        </tr>
325        <tr>
326          <td class="paramkey"></td>
327          <td></td>
328          <td class="paramtype">size_t&#160;</td>
329          <td class="paramname"><em>index</em>, </td>
330        </tr>
331        <tr>
332          <td class="paramkey"></td>
333          <td></td>
334          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
335          <td class="paramname"><em>value</em>&#160;</td>
336        </tr>
337        <tr>
338          <td></td>
339          <td>)</td>
340          <td></td><td></td>
341        </tr>
342      </table>
343</div><div class="memdoc">
344
345<p>Replace item at an index. </p>
346<p>The item being replace will be <a class="el" href="common_8h.html#aa10ebec46eddc9312ec46a0898b5d196" title="Decreases the reference count by one, deallocating the item if needed. ">cbor_decref</a> 'ed.</p>
347<dl class="params"><dt>Parameters</dt><dd>
348  <table class="params">
349    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
350    <tr><td class="paramname">value[incref]</td><td>The item to assign </td></tr>
351    <tr><td class="paramname">index</td><td>The index, first item is 0. </td></tr>
352  </table>
353  </dd>
354</dl>
355<dl class="section return"><dt>Returns</dt><dd>true on success, false on allocation failure. </dd></dl>
356
357<p>Definition at line <a class="el" href="arrays_8c_source.html#l00042">42</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
358
359</div>
360</div>
361<a id="a382cc2dc480ebb9c7951eb3235be89b4"></a>
362<h2 class="memtitle"><span class="permalink"><a href="#a382cc2dc480ebb9c7951eb3235be89b4">&sect;&nbsp;</a></span>cbor_array_set()</h2>
363
364<div class="memitem">
365<div class="memproto">
366      <table class="memname">
367        <tr>
368          <td class="memname">bool cbor_array_set </td>
369          <td>(</td>
370          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
371          <td class="paramname"><em>item</em>, </td>
372        </tr>
373        <tr>
374          <td class="paramkey"></td>
375          <td></td>
376          <td class="paramtype">size_t&#160;</td>
377          <td class="paramname"><em>index</em>, </td>
378        </tr>
379        <tr>
380          <td class="paramkey"></td>
381          <td></td>
382          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
383          <td class="paramname"><em>value</em>&#160;</td>
384        </tr>
385        <tr>
386          <td></td>
387          <td>)</td>
388          <td></td><td></td>
389        </tr>
390      </table>
391</div><div class="memdoc">
392
393<p>Set item by index. </p>
394<p>Creating arrays with holes is not possible</p>
395<dl class="params"><dt>Parameters</dt><dd>
396  <table class="params">
397    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
398    <tr><td class="paramname">value[incref]</td><td>The item to assign </td></tr>
399    <tr><td class="paramname">index</td><td>The index, first item is 0. </td></tr>
400  </table>
401  </dd>
402</dl>
403<dl class="section return"><dt>Returns</dt><dd>true on success, false on allocation failure. </dd></dl>
404
405<p>Definition at line <a class="el" href="arrays_8c_source.html#l00030">30</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
406
407</div>
408</div>
409<a id="a4f634a9a4bc834e4ea6ac43e94d51f84"></a>
410<h2 class="memtitle"><span class="permalink"><a href="#a4f634a9a4bc834e4ea6ac43e94d51f84">&sect;&nbsp;</a></span>cbor_array_size()</h2>
411
412<div class="memitem">
413<div class="memproto">
414      <table class="memname">
415        <tr>
416          <td class="memname">size_t cbor_array_size </td>
417          <td>(</td>
418          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
419          <td class="paramname"><em>item</em></td><td>)</td>
420          <td></td>
421        </tr>
422      </table>
423</div><div class="memdoc">
424
425<p>Get the number of members. </p>
426<dl class="params"><dt>Parameters</dt><dd>
427  <table class="params">
428    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
429  </table>
430  </dd>
431</dl>
432<dl class="section return"><dt>Returns</dt><dd>The number of members </dd></dl>
433
434<p>Definition at line <a class="el" href="arrays_8c_source.html#l00012">12</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
435
436</div>
437</div>
438<a id="a93d7c18019000d5e206a81a4cca70631"></a>
439<h2 class="memtitle"><span class="permalink"><a href="#a93d7c18019000d5e206a81a4cca70631">&sect;&nbsp;</a></span>cbor_new_definite_array()</h2>
440
441<div class="memitem">
442<div class="memproto">
443      <table class="memname">
444        <tr>
445          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_new_definite_array </td>
446          <td>(</td>
447          <td class="paramtype">size_t&#160;</td>
448          <td class="paramname"><em>size</em></td><td>)</td>
449          <td></td>
450        </tr>
451      </table>
452</div><div class="memdoc">
453
454<p>Create new definite array. </p>
455<dl class="params"><dt>Parameters</dt><dd>
456  <table class="params">
457    <tr><td class="paramname">size</td><td>Number of slots to preallocate </td></tr>
458  </table>
459  </dd>
460</dl>
461<dl class="section return"><dt>Returns</dt><dd><b>new</b> array or <code>NULL</code> upon malloc failure </dd></dl>
462
463<p>Definition at line <a class="el" href="arrays_8c_source.html#l00106">106</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
464
465</div>
466</div>
467<a id="aaec916ccc6f19782b6aef5ec1da2cc26"></a>
468<h2 class="memtitle"><span class="permalink"><a href="#aaec916ccc6f19782b6aef5ec1da2cc26">&sect;&nbsp;</a></span>cbor_new_indefinite_array()</h2>
469
470<div class="memitem">
471<div class="memproto">
472      <table class="memname">
473        <tr>
474          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_new_indefinite_array </td>
475          <td>(</td>
476          <td class="paramname"></td><td>)</td>
477          <td></td>
478        </tr>
479      </table>
480</div><div class="memdoc">
481
482<p>Create new indefinite array. </p>
483<dl class="section return"><dt>Returns</dt><dd><b>new</b> array or <code>NULL</code> upon malloc failure </dd></dl>
484
485<p>Definition at line <a class="el" href="arrays_8c_source.html#l00138">138</a> of file <a class="el" href="arrays_8c_source.html">arrays.c</a>.</p>
486
487</div>
488</div>
489</div><!-- contents -->
490<!-- start footer part -->
491<hr class="footer"/><address class="footer"><small>
492Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
493<img class="footer" src="doxygen.png" alt="doxygen"/>
494</a> 1.8.12
495</small></address>
496</body>
497</html>
498