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.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  <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.h File Reference</div> </div> 72</div><!--header--> 73<div class="contents"> 74<div class="textblock"><code>#include "<a class="el" href="data_8h_source.html">cbor/data.h</a>"</code><br /> 75<code>#include "<a class="el" href="common_8h_source.html">cbor/common.h</a>"</code><br /> 76<code>#include "<a class="el" href="arrays_8h_source.html">cbor/arrays.h</a>"</code><br /> 77<code>#include "<a class="el" href="bytestrings_8h_source.html">cbor/bytestrings.h</a>"</code><br /> 78<code>#include "<a class="el" href="floats__ctrls_8h_source.html">cbor/floats_ctrls.h</a>"</code><br /> 79<code>#include "<a class="el" href="ints_8h_source.html">cbor/ints.h</a>"</code><br /> 80<code>#include "<a class="el" href="maps_8h_source.html">cbor/maps.h</a>"</code><br /> 81<code>#include "<a class="el" href="strings_8h_source.html">cbor/strings.h</a>"</code><br /> 82<code>#include "<a class="el" href="tags_8h_source.html">cbor/tags.h</a>"</code><br /> 83<code>#include "<a class="el" href="encoding_8h_source.html">cbor/encoding.h</a>"</code><br /> 84<code>#include "<a class="el" href="serialization_8h_source.html">cbor/serialization.h</a>"</code><br /> 85<code>#include "<a class="el" href="callbacks_8h_source.html">cbor/callbacks.h</a>"</code><br /> 86<code>#include "<a class="el" href="streaming_8h_source.html">cbor/streaming.h</a>"</code><br /> 87</div> 88<p><a href="cbor_8h_source.html">Go to the source code of this file.</a></p> 89<table class="memberdecls"> 90<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 91Functions</h2></td></tr> 92<tr class="memitem:ae48d76b44e6de39a98ff3599d9acda8f"><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="cbor_8h.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> 93<tr class="memdesc:ae48d76b44e6de39a98ff3599d9acda8f"><td class="mdescLeft"> </td><td class="mdescRight">Loads data item from a buffer. <a href="#ae48d76b44e6de39a98ff3599d9acda8f">More...</a><br /></td></tr> 94<tr class="separator:ae48d76b44e6de39a98ff3599d9acda8f"><td class="memSeparator" colspan="2"> </td></tr> 95<tr class="memitem:ac54800327647ea17db0f40d72873f505"><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="cbor_8h.html#ac54800327647ea17db0f40d72873f505">cbor_copy</a> (<a class="el" href="structcbor__item__t.html">cbor_item_t</a> *item)</td></tr> 96<tr class="memdesc:ac54800327647ea17db0f40d72873f505"><td class="mdescLeft"> </td><td class="mdescRight">Deep copy of an item. <a href="#ac54800327647ea17db0f40d72873f505">More...</a><br /></td></tr> 97<tr class="separator:ac54800327647ea17db0f40d72873f505"><td class="memSeparator" colspan="2"> </td></tr> 98</table> 99<h2 class="groupheader">Function Documentation</h2> 100<a id="ac54800327647ea17db0f40d72873f505"></a> 101<h2 class="memtitle"><span class="permalink"><a href="#ac54800327647ea17db0f40d72873f505">§ </a></span>cbor_copy()</h2> 102 103<div class="memitem"> 104<div class="memproto"> 105 <table class="memname"> 106 <tr> 107 <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_copy </td> 108 <td>(</td> 109 <td class="paramtype"><a class="el" href="structcbor__item__t.html">cbor_item_t</a> * </td> 110 <td class="paramname"><em>item</em></td><td>)</td> 111 <td></td> 112 </tr> 113 </table> 114</div><div class="memdoc"> 115 116<p>Deep copy of an item. </p> 117<p>All the reference counts in the new structure are set to one.</p> 118<dl class="params"><dt>Parameters</dt><dd> 119 <table class="params"> 120 <tr><td class="paramname">item[borrow]</td><td>item to copy </td></tr> 121 </table> 122 </dd> 123</dl> 124<dl class="section return"><dt>Returns</dt><dd><b>new</b> CBOR deep copy </dd></dl> 125 126<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> 127 128</div> 129</div> 130<a id="ae48d76b44e6de39a98ff3599d9acda8f"></a> 131<h2 class="memtitle"><span class="permalink"><a href="#ae48d76b44e6de39a98ff3599d9acda8f">§ </a></span>cbor_load()</h2> 132 133<div class="memitem"> 134<div class="memproto"> 135 <table class="memname"> 136 <tr> 137 <td class="memname"><a class="el" href="structcbor__item__t.html">cbor_item_t</a>* cbor_load </td> 138 <td>(</td> 139 <td class="paramtype"><a class="el" href="data_8h.html#a121c5944682215e742475f12f07c0a72">cbor_data</a> </td> 140 <td class="paramname"><em>source</em>, </td> 141 </tr> 142 <tr> 143 <td class="paramkey"></td> 144 <td></td> 145 <td class="paramtype">size_t </td> 146 <td class="paramname"><em>source_size</em>, </td> 147 </tr> 148 <tr> 149 <td class="paramkey"></td> 150 <td></td> 151 <td class="paramtype">struct <a class="el" href="structcbor__load__result.html">cbor_load_result</a> * </td> 152 <td class="paramname"><em>result</em> </td> 153 </tr> 154 <tr> 155 <td></td> 156 <td>)</td> 157 <td></td><td></td> 158 </tr> 159 </table> 160</div><div class="memdoc"> 161 162<p>Loads data item from a buffer. </p> 163<dl class="params"><dt>Parameters</dt><dd> 164 <table class="params"> 165 <tr><td class="paramname">source</td><td>The buffer </td></tr> 166 <tr><td class="paramname">source_size</td><td></td></tr> 167 <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> 168 </table> 169 </dd> 170</dl> 171<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> 172 173<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> 174 175</div> 176</div> 177</div><!-- contents --> 178<!-- start footer part --> 179<hr class="footer"/><address class="footer"><small> 180Generated on Mon Feb 6 2017 00:26:19 for libcbor by  <a href="http://www.doxygen.org/index.html"> 181<img class="footer" src="doxygen.png" alt="doxygen"/> 182</a> 1.8.12 183</small></address> 184</body> 185</html> 186
