xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/cbor_8c.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.c 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>  </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">cbor.c File Reference</div>  </div>
72</div><!--header-->
73<div class="contents">
74<div class="textblock"><code>#include &quot;<a class="el" href="cbor_8h_source.html">cbor.h</a>&quot;</code><br />
75<code>#include &quot;<a class="el" href="builder__callbacks_8h_source.html">cbor/internal/builder_callbacks.h</a>&quot;</code><br />
76<code>#include &quot;<a class="el" href="loaders_8h_source.html">cbor/internal/loaders.h</a>&quot;</code><br />
77</div>
78<p><a href="cbor_8c_source.html">Go to the source code of this file.</a></p>
79<table class="memberdecls">
80<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
81Functions</h2></td></tr>
82<tr class="memitem:ae48d76b44e6de39a98ff3599d9acda8f"><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="cbor_8c.html#ae48d76b44e6de39a98ff3599d9acda8f">cbor_load</a> (<a class="el" href="data_8h.html#a121c5944682215e742475f12f07c0a72">cbor_data</a> source, size_t source_size, struct <a class="el" href="structcbor__load__result.html">cbor_load_result</a> *result)</td></tr>
83<tr class="memdesc:ae48d76b44e6de39a98ff3599d9acda8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads data item from a buffer.  <a href="#ae48d76b44e6de39a98ff3599d9acda8f">More...</a><br /></td></tr>
84<tr class="separator:ae48d76b44e6de39a98ff3599d9acda8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
85<tr class="memitem:ac54800327647ea17db0f40d72873f505"><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="cbor_8c.html#ac54800327647ea17db0f40d72873f505">cbor_copy</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr>
86<tr class="memdesc:ac54800327647ea17db0f40d72873f505"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deep copy of an item.  <a href="#ac54800327647ea17db0f40d72873f505">More...</a><br /></td></tr>
87<tr class="separator:ac54800327647ea17db0f40d72873f505"><td class="memSeparator" colspan="2">&#160;</td></tr>
88</table>
89<h2 class="groupheader">Function Documentation</h2>
90<a id="ac54800327647ea17db0f40d72873f505"></a>
91<h2 class="memtitle"><span class="permalink"><a href="#ac54800327647ea17db0f40d72873f505">&sect;&nbsp;</a></span>cbor_copy()</h2>
92
93<div class="memitem">
94<div class="memproto">
95      <table class="memname">
96        <tr>
97          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_copy </td>
98          <td>(</td>
99          <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> *&#160;</td>
100          <td class="paramname"><em>item</em></td><td>)</td>
101          <td></td>
102        </tr>
103      </table>
104</div><div class="memdoc">
105
106<p>Deep copy of an item. </p>
107<p>All the reference counts in the new structure are set to one.</p>
108<dl class="params"><dt>Parameters</dt><dd>
109  <table class="params">
110    <tr><td class="paramname">item[borrow]</td><td>item to copy </td></tr>
111  </table>
112  </dd>
113</dl>
114<dl class="section return"><dt>Returns</dt><dd><b>new</b> CBOR deep copy </dd></dl>
115
116<p>Definition at line <a class="el" href="cbor_8c_source.html#l00164">164</a> of file <a class="el" href="cbor_8c_source.html">cbor.c</a>.</p>
117
118</div>
119</div>
120<a id="ae48d76b44e6de39a98ff3599d9acda8f"></a>
121<h2 class="memtitle"><span class="permalink"><a href="#ae48d76b44e6de39a98ff3599d9acda8f">&sect;&nbsp;</a></span>cbor_load()</h2>
122
123<div class="memitem">
124<div class="memproto">
125      <table class="memname">
126        <tr>
127          <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_load </td>
128          <td>(</td>
129          <td class="paramtype"><a class="el" href="data_8h.html#a121c5944682215e742475f12f07c0a72">cbor_data</a>&#160;</td>
130          <td class="paramname"><em>source</em>, </td>
131        </tr>
132        <tr>
133          <td class="paramkey"></td>
134          <td></td>
135          <td class="paramtype">size_t&#160;</td>
136          <td class="paramname"><em>source_size</em>, </td>
137        </tr>
138        <tr>
139          <td class="paramkey"></td>
140          <td></td>
141          <td class="paramtype">struct <a class="el" href="structcbor__load__result.html">cbor_load_result</a> *&#160;</td>
142          <td class="paramname"><em>result</em>&#160;</td>
143        </tr>
144        <tr>
145          <td></td>
146          <td>)</td>
147          <td></td><td></td>
148        </tr>
149      </table>
150</div><div class="memdoc">
151
152<p>Loads data item from a buffer. </p>
153<dl class="params"><dt>Parameters</dt><dd>
154  <table class="params">
155    <tr><td class="paramname">source</td><td>The buffer </td></tr>
156    <tr><td class="paramname">source_size</td><td></td></tr>
157    <tr><td class="paramname">result[out]</td><td>Result indicator. <a class="el" href="data_8h.html#a13ad43c61d917938e0ce26173e6b2eb6a711ecd32adcc030541f2cfb58f69856d">CBOR_ERR_NONE</a> on success </td></tr>
158  </table>
159  </dd>
160</dl>
161<dl class="section return"><dt>Returns</dt><dd><b>new</b> CBOR item or <code>NULL</code> on failure. In that case, <code>result</code> contains location and description of the error. </dd></dl>
162
163<p>Definition at line <a class="el" href="cbor_8c_source.html#l00012">12</a> of file <a class="el" href="cbor_8c_source.html">cbor.c</a>.</p>
164
165</div>
166</div>
167</div><!-- contents -->
168<!-- start footer part -->
169<hr class="footer"/><address class="footer"><small>
170Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
171<img class="footer" src="doxygen.png" alt="doxygen"/>
172</a> 1.8.12
173</small></address>
174</body>
175</html>
176