xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/structcbor__item__t.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: cbor_item_t Struct 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><!-- top -->
63<div class="header">
64  <div class="summary">
65<a href="#pub-attribs">Data Fields</a>  </div>
66  <div class="headertitle">
67<div class="title">cbor_item_t Struct Reference</div>  </div>
68</div><!--header-->
69<div class="contents">
70
71<p>The item handle.
72 <a href="structcbor__item__t.html#details">More...</a></p>
73
74<p><code>#include &lt;<a class="el" href="data_8h_source.html">data.h</a>&gt;</code></p>
75<table class="memberdecls">
76<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
77Data Fields</h2></td></tr>
78<tr class="memitem:a7d97fa5cdf027ca0499c37ec19acf843"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="unioncbor__item__metadata.html">cbor_item_metadata</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcbor__item__t.html#a7d97fa5cdf027ca0499c37ec19acf843">metadata</a></td></tr>
79<tr class="memdesc:a7d97fa5cdf027ca0499c37ec19acf843"><td class="mdescLeft">&#160;</td><td class="mdescRight">Discriminated by type.  <a href="#a7d97fa5cdf027ca0499c37ec19acf843">More...</a><br /></td></tr>
80<tr class="separator:a7d97fa5cdf027ca0499c37ec19acf843"><td class="memSeparator" colspan="2">&#160;</td></tr>
81<tr class="memitem:a6bb24fe655f086c6aa9a66d427e09cca"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcbor__item__t.html#a6bb24fe655f086c6aa9a66d427e09cca">refcount</a></td></tr>
82<tr class="memdesc:a6bb24fe655f086c6aa9a66d427e09cca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference count - initialize to 0.  <a href="#a6bb24fe655f086c6aa9a66d427e09cca">More...</a><br /></td></tr>
83<tr class="separator:a6bb24fe655f086c6aa9a66d427e09cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
84<tr class="memitem:a6743a75cf89e1b455ddf3198ff98842a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="data_8h.html#a3a931b40fc31b51cccfd1bc3dc5fc5d6">cbor_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcbor__item__t.html#a6743a75cf89e1b455ddf3198ff98842a">type</a></td></tr>
85<tr class="memdesc:a6743a75cf89e1b455ddf3198ff98842a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Major type discriminator.  <a href="#a6743a75cf89e1b455ddf3198ff98842a">More...</a><br /></td></tr>
86<tr class="separator:a6743a75cf89e1b455ddf3198ff98842a"><td class="memSeparator" colspan="2">&#160;</td></tr>
87<tr class="memitem:a5c6dde1dbef5aad748c49786352eef44"><td class="memItemLeft" align="right" valign="top">unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcbor__item__t.html#a5c6dde1dbef5aad748c49786352eef44">data</a></td></tr>
88<tr class="memdesc:a5c6dde1dbef5aad748c49786352eef44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raw data block - interpretation depends on metadata.  <a href="#a5c6dde1dbef5aad748c49786352eef44">More...</a><br /></td></tr>
89<tr class="separator:a5c6dde1dbef5aad748c49786352eef44"><td class="memSeparator" colspan="2">&#160;</td></tr>
90</table>
91<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
92<div class="textblock"><p>The item handle. </p>
93
94<p>Definition at line <a class="el" href="data_8h_source.html#l00149">149</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
95</div><h2 class="groupheader">Field Documentation</h2>
96<a id="a5c6dde1dbef5aad748c49786352eef44"></a>
97<h2 class="memtitle"><span class="permalink"><a href="#a5c6dde1dbef5aad748c49786352eef44">&sect;&nbsp;</a></span>data</h2>
98
99<div class="memitem">
100<div class="memproto">
101      <table class="memname">
102        <tr>
103          <td class="memname">unsigned char* cbor_item_t::data</td>
104        </tr>
105      </table>
106</div><div class="memdoc">
107
108<p>Raw data block - interpretation depends on metadata. </p>
109
110<p>Definition at line <a class="el" href="data_8h_source.html#l00157">157</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
111
112</div>
113</div>
114<a id="a7d97fa5cdf027ca0499c37ec19acf843"></a>
115<h2 class="memtitle"><span class="permalink"><a href="#a7d97fa5cdf027ca0499c37ec19acf843">&sect;&nbsp;</a></span>metadata</h2>
116
117<div class="memitem">
118<div class="memproto">
119      <table class="memname">
120        <tr>
121          <td class="memname">union <a class="el" href="unioncbor__item__metadata.html">cbor_item_metadata</a> cbor_item_t::metadata</td>
122        </tr>
123      </table>
124</div><div class="memdoc">
125
126<p>Discriminated by type. </p>
127
128<p>Definition at line <a class="el" href="data_8h_source.html#l00151">151</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
129
130</div>
131</div>
132<a id="a6bb24fe655f086c6aa9a66d427e09cca"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#a6bb24fe655f086c6aa9a66d427e09cca">&sect;&nbsp;</a></span>refcount</h2>
134
135<div class="memitem">
136<div class="memproto">
137      <table class="memname">
138        <tr>
139          <td class="memname">size_t cbor_item_t::refcount</td>
140        </tr>
141      </table>
142</div><div class="memdoc">
143
144<p>Reference count - initialize to 0. </p>
145
146<p>Definition at line <a class="el" href="data_8h_source.html#l00153">153</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
147
148</div>
149</div>
150<a id="a6743a75cf89e1b455ddf3198ff98842a"></a>
151<h2 class="memtitle"><span class="permalink"><a href="#a6743a75cf89e1b455ddf3198ff98842a">&sect;&nbsp;</a></span>type</h2>
152
153<div class="memitem">
154<div class="memproto">
155      <table class="memname">
156        <tr>
157          <td class="memname"><a class="el" href="data_8h.html#a3a931b40fc31b51cccfd1bc3dc5fc5d6">cbor_type</a> cbor_item_t::type</td>
158        </tr>
159      </table>
160</div><div class="memdoc">
161
162<p>Major type discriminator. </p>
163
164<p>Definition at line <a class="el" href="data_8h_source.html#l00155">155</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
165
166</div>
167</div>
168<hr/>The documentation for this struct was generated from the following file:<ul>
169<li>src/cbor/<a class="el" href="data_8h_source.html">data.h</a></li>
170</ul>
171</div><!-- contents -->
172<!-- start footer part -->
173<hr class="footer"/><address class="footer"><small>
174Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
175<img class="footer" src="doxygen.png" alt="doxygen"/>
176</a> 1.8.12
177</small></address>
178</body>
179</html>
180