xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/serialization_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/serialization.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">serialization.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="serialization_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:a2b99415a2c6f0d226116c707772e2fc0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#a2b99415a2c6f0d226116c707772e2fc0">cbor_serialize</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a> buffer, size_t buffer_size)</td></tr>
81<tr class="memdesc:a2b99415a2c6f0d226116c707772e2fc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize the given item.  <a href="#a2b99415a2c6f0d226116c707772e2fc0">More...</a><br /></td></tr>
82<tr class="separator:a2b99415a2c6f0d226116c707772e2fc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
83<tr class="memitem:ab8a96a82216c07469a583eef3a3dd8d0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#ab8a96a82216c07469a583eef3a3dd8d0">cbor_serialize_alloc</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a> *buffer, size_t *buffer_size)</td></tr>
84<tr class="memdesc:ab8a96a82216c07469a583eef3a3dd8d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize the given item, allocating buffers as needed.  <a href="#ab8a96a82216c07469a583eef3a3dd8d0">More...</a><br /></td></tr>
85<tr class="separator:ab8a96a82216c07469a583eef3a3dd8d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
86<tr class="memitem:a649fbb28229d58193a7eee96995929e0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#a649fbb28229d58193a7eee96995929e0">cbor_serialize_uint</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
87<tr class="memdesc:a649fbb28229d58193a7eee96995929e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize an uint.  <a href="#a649fbb28229d58193a7eee96995929e0">More...</a><br /></td></tr>
88<tr class="separator:a649fbb28229d58193a7eee96995929e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
89<tr class="memitem:ad7eb1501bd8282c21675333759dc7291"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#ad7eb1501bd8282c21675333759dc7291">cbor_serialize_negint</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
90<tr class="memdesc:ad7eb1501bd8282c21675333759dc7291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a negint.  <a href="#ad7eb1501bd8282c21675333759dc7291">More...</a><br /></td></tr>
91<tr class="separator:ad7eb1501bd8282c21675333759dc7291"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<tr class="memitem:aeff4847e92b05b329edd1135c60f4179"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#aeff4847e92b05b329edd1135c60f4179">cbor_serialize_bytestring</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
93<tr class="memdesc:aeff4847e92b05b329edd1135c60f4179"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a bytestring.  <a href="#aeff4847e92b05b329edd1135c60f4179">More...</a><br /></td></tr>
94<tr class="separator:aeff4847e92b05b329edd1135c60f4179"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<tr class="memitem:a9fb1138391d20c1b81081e2a5f413c3d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#a9fb1138391d20c1b81081e2a5f413c3d">cbor_serialize_string</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
96<tr class="memdesc:a9fb1138391d20c1b81081e2a5f413c3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a string.  <a href="#a9fb1138391d20c1b81081e2a5f413c3d">More...</a><br /></td></tr>
97<tr class="separator:a9fb1138391d20c1b81081e2a5f413c3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:a53e7d680cf41ccda369802deaf6c1ba8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#a53e7d680cf41ccda369802deaf6c1ba8">cbor_serialize_array</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
99<tr class="memdesc:a53e7d680cf41ccda369802deaf6c1ba8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize an array.  <a href="#a53e7d680cf41ccda369802deaf6c1ba8">More...</a><br /></td></tr>
100<tr class="separator:a53e7d680cf41ccda369802deaf6c1ba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<tr class="memitem:a1c07f653f5aa66fadc82f24f556a162d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#a1c07f653f5aa66fadc82f24f556a162d">cbor_serialize_map</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
102<tr class="memdesc:a1c07f653f5aa66fadc82f24f556a162d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a map.  <a href="#a1c07f653f5aa66fadc82f24f556a162d">More...</a><br /></td></tr>
103<tr class="separator:a1c07f653f5aa66fadc82f24f556a162d"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<tr class="memitem:ae67b7ceefe645e660df73bf7ea255668"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#ae67b7ceefe645e660df73bf7ea255668">cbor_serialize_tag</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
105<tr class="memdesc:ae67b7ceefe645e660df73bf7ea255668"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a tag.  <a href="#ae67b7ceefe645e660df73bf7ea255668">More...</a><br /></td></tr>
106<tr class="separator:ae67b7ceefe645e660df73bf7ea255668"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:ad232a99d06a972ca114a2fe753b90953"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="serialization_8h.html#ad232a99d06a972ca114a2fe753b90953">cbor_serialize_float_ctrl</a> (const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *, <a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>, size_t)</td></tr>
108<tr class="memdesc:ad232a99d06a972ca114a2fe753b90953"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a.  <a href="#ad232a99d06a972ca114a2fe753b90953">More...</a><br /></td></tr>
109<tr class="separator:ad232a99d06a972ca114a2fe753b90953"><td class="memSeparator" colspan="2">&#160;</td></tr>
110</table>
111<h2 class="groupheader">Function Documentation</h2>
112<a id="a2b99415a2c6f0d226116c707772e2fc0"></a>
113<h2 class="memtitle"><span class="permalink"><a href="#a2b99415a2c6f0d226116c707772e2fc0">&sect;&nbsp;</a></span>cbor_serialize()</h2>
114
115<div class="memitem">
116<div class="memproto">
117      <table class="memname">
118        <tr>
119          <td class="memname">size_t cbor_serialize </td>
120          <td>(</td>
121          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
122          <td class="paramname"><em>item</em>, </td>
123        </tr>
124        <tr>
125          <td class="paramkey"></td>
126          <td></td>
127          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
128          <td class="paramname"><em>buffer</em>, </td>
129        </tr>
130        <tr>
131          <td class="paramkey"></td>
132          <td></td>
133          <td class="paramtype">size_t&#160;</td>
134          <td class="paramname"><em>buffer_size</em>&#160;</td>
135        </tr>
136        <tr>
137          <td></td>
138          <td>)</td>
139          <td></td><td></td>
140        </tr>
141      </table>
142</div><div class="memdoc">
143
144<p>Serialize the given item. </p>
145<dl class="params"><dt>Parameters</dt><dd>
146  <table class="params">
147    <tr><td class="paramname">item[borrow]</td><td>A data item </td></tr>
148    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
149    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
150  </table>
151  </dd>
152</dl>
153<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
154
155<p>Definition at line <a class="el" href="serialization_8c_source.html#l00020">20</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
156
157</div>
158</div>
159<a id="ab8a96a82216c07469a583eef3a3dd8d0"></a>
160<h2 class="memtitle"><span class="permalink"><a href="#ab8a96a82216c07469a583eef3a3dd8d0">&sect;&nbsp;</a></span>cbor_serialize_alloc()</h2>
161
162<div class="memitem">
163<div class="memproto">
164      <table class="memname">
165        <tr>
166          <td class="memname">size_t cbor_serialize_alloc </td>
167          <td>(</td>
168          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
169          <td class="paramname"><em>item</em>, </td>
170        </tr>
171        <tr>
172          <td class="paramkey"></td>
173          <td></td>
174          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a> *&#160;</td>
175          <td class="paramname"><em>buffer</em>, </td>
176        </tr>
177        <tr>
178          <td class="paramkey"></td>
179          <td></td>
180          <td class="paramtype">size_t *&#160;</td>
181          <td class="paramname"><em>buffer_size</em>&#160;</td>
182        </tr>
183        <tr>
184          <td></td>
185          <td>)</td>
186          <td></td><td></td>
187        </tr>
188      </table>
189</div><div class="memdoc">
190
191<p>Serialize the given item, allocating buffers as needed. </p>
192<pre class="fragment">embed:rst:leading-asterisk
193* .. warning:: It is your responsibility to free the buffer using an appropriate ``free`` implementation.
194* </pre><dl class="params"><dt>Parameters</dt><dd>
195  <table class="params">
196    <tr><td class="paramname">item[borrow]</td><td>A data item </td></tr>
197    <tr><td class="paramname">buffer[out]</td><td>Buffer containing the result </td></tr>
198    <tr><td class="paramname">buffer_size[out]</td><td>Size of the <code>buffer</code> </td></tr>
199  </table>
200  </dd>
201</dl>
202<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure, in which case <code>buffer</code> is <code>NULL</code>. </dd></dl>
203
204<p>Definition at line <a class="el" href="serialization_8c_source.html#l00044">44</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
205
206</div>
207</div>
208<a id="a53e7d680cf41ccda369802deaf6c1ba8"></a>
209<h2 class="memtitle"><span class="permalink"><a href="#a53e7d680cf41ccda369802deaf6c1ba8">&sect;&nbsp;</a></span>cbor_serialize_array()</h2>
210
211<div class="memitem">
212<div class="memproto">
213      <table class="memname">
214        <tr>
215          <td class="memname">size_t cbor_serialize_array </td>
216          <td>(</td>
217          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
218          <td class="paramname">, </td>
219        </tr>
220        <tr>
221          <td class="paramkey"></td>
222          <td></td>
223          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
224          <td class="paramname">, </td>
225        </tr>
226        <tr>
227          <td class="paramkey"></td>
228          <td></td>
229          <td class="paramtype">size_t&#160;</td>
230          <td class="paramname">&#160;</td>
231        </tr>
232        <tr>
233          <td></td>
234          <td>)</td>
235          <td></td><td></td>
236        </tr>
237      </table>
238</div><div class="memdoc">
239
240<p>Serialize an array. </p>
241<dl class="params"><dt>Parameters</dt><dd>
242  <table class="params">
243    <tr><td class="paramname">item[borrow]</td><td>An array </td></tr>
244    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
245    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
246  </table>
247  </dd>
248</dl>
249<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
250
251<p>Definition at line <a class="el" href="serialization_8c_source.html#l00178">178</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
252
253</div>
254</div>
255<a id="aeff4847e92b05b329edd1135c60f4179"></a>
256<h2 class="memtitle"><span class="permalink"><a href="#aeff4847e92b05b329edd1135c60f4179">&sect;&nbsp;</a></span>cbor_serialize_bytestring()</h2>
257
258<div class="memitem">
259<div class="memproto">
260      <table class="memname">
261        <tr>
262          <td class="memname">size_t cbor_serialize_bytestring </td>
263          <td>(</td>
264          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
265          <td class="paramname">, </td>
266        </tr>
267        <tr>
268          <td class="paramkey"></td>
269          <td></td>
270          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
271          <td class="paramname">, </td>
272        </tr>
273        <tr>
274          <td class="paramkey"></td>
275          <td></td>
276          <td class="paramtype">size_t&#160;</td>
277          <td class="paramname">&#160;</td>
278        </tr>
279        <tr>
280          <td></td>
281          <td>)</td>
282          <td></td><td></td>
283        </tr>
284      </table>
285</div><div class="memdoc">
286
287<p>Serialize a bytestring. </p>
288<dl class="params"><dt>Parameters</dt><dd>
289  <table class="params">
290    <tr><td class="paramname">item[borrow]</td><td>A bytestring </td></tr>
291    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
292    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
293  </table>
294  </dd>
295</dl>
296<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
297
298<p>Definition at line <a class="el" href="serialization_8c_source.html#l00110">110</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
299
300</div>
301</div>
302<a id="ad232a99d06a972ca114a2fe753b90953"></a>
303<h2 class="memtitle"><span class="permalink"><a href="#ad232a99d06a972ca114a2fe753b90953">&sect;&nbsp;</a></span>cbor_serialize_float_ctrl()</h2>
304
305<div class="memitem">
306<div class="memproto">
307      <table class="memname">
308        <tr>
309          <td class="memname">size_t cbor_serialize_float_ctrl </td>
310          <td>(</td>
311          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
312          <td class="paramname">, </td>
313        </tr>
314        <tr>
315          <td class="paramkey"></td>
316          <td></td>
317          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
318          <td class="paramname">, </td>
319        </tr>
320        <tr>
321          <td class="paramkey"></td>
322          <td></td>
323          <td class="paramtype">size_t&#160;</td>
324          <td class="paramname">&#160;</td>
325        </tr>
326        <tr>
327          <td></td>
328          <td>)</td>
329          <td></td><td></td>
330        </tr>
331      </table>
332</div><div class="memdoc">
333
334<p>Serialize a. </p>
335<dl class="params"><dt>Parameters</dt><dd>
336  <table class="params">
337    <tr><td class="paramname">item[borrow]</td><td>A float or ctrl </td></tr>
338    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
339    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
340  </table>
341  </dd>
342</dl>
343<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
344
345<p>Definition at line <a class="el" href="serialization_8c_source.html#l00270">270</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
346
347</div>
348</div>
349<a id="a1c07f653f5aa66fadc82f24f556a162d"></a>
350<h2 class="memtitle"><span class="permalink"><a href="#a1c07f653f5aa66fadc82f24f556a162d">&sect;&nbsp;</a></span>cbor_serialize_map()</h2>
351
352<div class="memitem">
353<div class="memproto">
354      <table class="memname">
355        <tr>
356          <td class="memname">size_t cbor_serialize_map </td>
357          <td>(</td>
358          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
359          <td class="paramname">, </td>
360        </tr>
361        <tr>
362          <td class="paramkey"></td>
363          <td></td>
364          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
365          <td class="paramname">, </td>
366        </tr>
367        <tr>
368          <td class="paramkey"></td>
369          <td></td>
370          <td class="paramtype">size_t&#160;</td>
371          <td class="paramname">&#160;</td>
372        </tr>
373        <tr>
374          <td></td>
375          <td>)</td>
376          <td></td><td></td>
377        </tr>
378      </table>
379</div><div class="memdoc">
380
381<p>Serialize a map. </p>
382<dl class="params"><dt>Parameters</dt><dd>
383  <table class="params">
384    <tr><td class="paramname">item[borrow]</td><td>A map </td></tr>
385    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
386    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
387  </table>
388  </dd>
389</dl>
390<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
391
392<p>Definition at line <a class="el" href="serialization_8c_source.html#l00214">214</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
393
394</div>
395</div>
396<a id="ad7eb1501bd8282c21675333759dc7291"></a>
397<h2 class="memtitle"><span class="permalink"><a href="#ad7eb1501bd8282c21675333759dc7291">&sect;&nbsp;</a></span>cbor_serialize_negint()</h2>
398
399<div class="memitem">
400<div class="memproto">
401      <table class="memname">
402        <tr>
403          <td class="memname">size_t cbor_serialize_negint </td>
404          <td>(</td>
405          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
406          <td class="paramname">, </td>
407        </tr>
408        <tr>
409          <td class="paramkey"></td>
410          <td></td>
411          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
412          <td class="paramname">, </td>
413        </tr>
414        <tr>
415          <td class="paramkey"></td>
416          <td></td>
417          <td class="paramtype">size_t&#160;</td>
418          <td class="paramname">&#160;</td>
419        </tr>
420        <tr>
421          <td></td>
422          <td>)</td>
423          <td></td><td></td>
424        </tr>
425      </table>
426</div><div class="memdoc">
427
428<p>Serialize a negint. </p>
429<dl class="params"><dt>Parameters</dt><dd>
430  <table class="params">
431    <tr><td class="paramname">item[borrow]</td><td>A neging </td></tr>
432    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
433    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
434  </table>
435  </dd>
436</dl>
437<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
438
439<p>Definition at line <a class="el" href="serialization_8c_source.html#l00093">93</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
440
441</div>
442</div>
443<a id="a9fb1138391d20c1b81081e2a5f413c3d"></a>
444<h2 class="memtitle"><span class="permalink"><a href="#a9fb1138391d20c1b81081e2a5f413c3d">&sect;&nbsp;</a></span>cbor_serialize_string()</h2>
445
446<div class="memitem">
447<div class="memproto">
448      <table class="memname">
449        <tr>
450          <td class="memname">size_t cbor_serialize_string </td>
451          <td>(</td>
452          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
453          <td class="paramname">, </td>
454        </tr>
455        <tr>
456          <td class="paramkey"></td>
457          <td></td>
458          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
459          <td class="paramname">, </td>
460        </tr>
461        <tr>
462          <td class="paramkey"></td>
463          <td></td>
464          <td class="paramtype">size_t&#160;</td>
465          <td class="paramname">&#160;</td>
466        </tr>
467        <tr>
468          <td></td>
469          <td>)</td>
470          <td></td><td></td>
471        </tr>
472      </table>
473</div><div class="memdoc">
474
475<p>Serialize a string. </p>
476<dl class="params"><dt>Parameters</dt><dd>
477  <table class="params">
478    <tr><td class="paramname">item[borrow]</td><td>A string </td></tr>
479    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
480    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
481  </table>
482  </dd>
483</dl>
484<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
485
486<p>Definition at line <a class="el" href="serialization_8c_source.html#l00144">144</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
487
488</div>
489</div>
490<a id="ae67b7ceefe645e660df73bf7ea255668"></a>
491<h2 class="memtitle"><span class="permalink"><a href="#ae67b7ceefe645e660df73bf7ea255668">&sect;&nbsp;</a></span>cbor_serialize_tag()</h2>
492
493<div class="memitem">
494<div class="memproto">
495      <table class="memname">
496        <tr>
497          <td class="memname">size_t cbor_serialize_tag </td>
498          <td>(</td>
499          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
500          <td class="paramname">, </td>
501        </tr>
502        <tr>
503          <td class="paramkey"></td>
504          <td></td>
505          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
506          <td class="paramname">, </td>
507        </tr>
508        <tr>
509          <td class="paramkey"></td>
510          <td></td>
511          <td class="paramtype">size_t&#160;</td>
512          <td class="paramname">&#160;</td>
513        </tr>
514        <tr>
515          <td></td>
516          <td>)</td>
517          <td></td><td></td>
518        </tr>
519      </table>
520</div><div class="memdoc">
521
522<p>Serialize a tag. </p>
523<dl class="params"><dt>Parameters</dt><dd>
524  <table class="params">
525    <tr><td class="paramname">item[borrow]</td><td>A tag </td></tr>
526    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
527    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
528  </table>
529  </dd>
530</dl>
531<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
532
533<p>Definition at line <a class="el" href="serialization_8c_source.html#l00256">256</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
534
535</div>
536</div>
537<a id="a649fbb28229d58193a7eee96995929e0"></a>
538<h2 class="memtitle"><span class="permalink"><a href="#a649fbb28229d58193a7eee96995929e0">&sect;&nbsp;</a></span>cbor_serialize_uint()</h2>
539
540<div class="memitem">
541<div class="memproto">
542      <table class="memname">
543        <tr>
544          <td class="memname">size_t cbor_serialize_uint </td>
545          <td>(</td>
546          <td class="paramtype">const <a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
547          <td class="paramname">, </td>
548        </tr>
549        <tr>
550          <td class="paramkey"></td>
551          <td></td>
552          <td class="paramtype"><a class="el" href="data_8h.html#aabb40e458ece40477e134a69c76693e8">cbor_mutable_data</a>&#160;</td>
553          <td class="paramname">, </td>
554        </tr>
555        <tr>
556          <td class="paramkey"></td>
557          <td></td>
558          <td class="paramtype">size_t&#160;</td>
559          <td class="paramname">&#160;</td>
560        </tr>
561        <tr>
562          <td></td>
563          <td>)</td>
564          <td></td><td></td>
565        </tr>
566      </table>
567</div><div class="memdoc">
568
569<p>Serialize an uint. </p>
570<dl class="params"><dt>Parameters</dt><dd>
571  <table class="params">
572    <tr><td class="paramname">item[borrow]</td><td>A uint </td></tr>
573    <tr><td class="paramname">buffer</td><td>Buffer to serialize to </td></tr>
574    <tr><td class="paramname">buffer_size</td><td>Size of the <code>buffer</code> </td></tr>
575  </table>
576  </dd>
577</dl>
578<dl class="section return"><dt>Returns</dt><dd>Length of the result. 0 on failure. </dd></dl>
579
580<p>Definition at line <a class="el" href="serialization_8c_source.html#l00076">76</a> of file <a class="el" href="serialization_8c_source.html">serialization.c</a>.</p>
581
582</div>
583</div>
584</div><!-- contents -->
585<!-- start footer part -->
586<hr class="footer"/><address class="footer"><small>
587Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
588<img class="footer" src="doxygen.png" alt="doxygen"/>
589</a> 1.8.12
590</small></address>
591</body>
592</html>
593