xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/annotated.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: Data Structures</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</div><!-- top -->
49<!-- window showing the filter options -->
50<div id="MSearchSelectWindow"
51     onmouseover="return searchBox.OnSearchSelectShow()"
52     onmouseout="return searchBox.OnSearchSelectHide()"
53     onkeydown="return searchBox.OnSearchSelectKey(event)">
54</div>
55
56<!-- iframe showing the search results (closed by default) -->
57<div id="MSearchResultsWindow">
58<iframe src="javascript:void(0)" frameborder="0"
59        name="MSearchResults" id="MSearchResults">
60</iframe>
61</div>
62
63<div class="header">
64  <div class="headertitle">
65<div class="title">Data Structures</div>  </div>
66</div><!--header-->
67<div class="contents">
68<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
69<table class="directory">
70<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__array__metadata.html" target="_self">_cbor_array_metadata</a></td><td class="desc">Arrays specific metadata </td></tr>
71<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__bytestring__metadata.html" target="_self">_cbor_bytestring_metadata</a></td><td class="desc">Bytestrings specific metadata </td></tr>
72<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__decoder__context.html" target="_self">_cbor_decoder_context</a></td><td class="desc">High-level decoding context </td></tr>
73<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="union__cbor__double__helper.html" target="_self">_cbor_double_helper</a></td><td class="desc">Raw memory casts helper </td></tr>
74<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__float__ctrl__metadata.html" target="_self">_cbor_float_ctrl_metadata</a></td><td class="desc">Floats specific metadata - includes CTRL values </td></tr>
75<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="union__cbor__float__helper.html" target="_self">_cbor_float_helper</a></td><td class="desc">Raw memory casts helper </td></tr>
76<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__int__metadata.html" target="_self">_cbor_int_metadata</a></td><td class="desc">Integers specific metadata </td></tr>
77<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__map__metadata.html" target="_self">_cbor_map_metadata</a></td><td class="desc">Maps specific metadata </td></tr>
78<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__stack.html" target="_self">_cbor_stack</a></td><td class="desc">Stack handle - contents and size </td></tr>
79<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__stack__record.html" target="_self">_cbor_stack_record</a></td><td class="desc">Simple stack record for the parser </td></tr>
80<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__string__metadata.html" target="_self">_cbor_string_metadata</a></td><td class="desc">Strings specific metadata </td></tr>
81<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__tag__metadata.html" target="_self">_cbor_tag_metadata</a></td><td class="desc">Arrays specific metadata </td></tr>
82<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct__cbor__unicode__status.html" target="_self">_cbor_unicode_status</a></td><td class="desc">Signals unicode validation error and possibly its location </td></tr>
83<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__callbacks.html" target="_self">cbor_callbacks</a></td><td class="desc">Callback bundle &ndash; passed to the decoder </td></tr>
84<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__decoder__result.html" target="_self">cbor_decoder_result</a></td><td class="desc">Streaming decoder result </td></tr>
85<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__error.html" target="_self">cbor_error</a></td><td class="desc">High-level decoding error </td></tr>
86<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__indefinite__string__data.html" target="_self">cbor_indefinite_string_data</a></td><td class="desc">Defines <a class="el" href="structcbor__item__t.html#a5c6dde1dbef5aad748c49786352eef44" title="Raw data block - interpretation depends on metadata. ">cbor_item_t::data</a> structure for indefinite strings and bytestrings </td></tr>
87<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unioncbor__item__metadata.html" target="_self">cbor_item_metadata</a></td><td class="desc">Union of metadata across all possible types - discriminated in <a class="el" href="structcbor__item__t.html" title="The item handle. ">cbor_item_t</a> </td></tr>
88<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__item__t.html" target="_self">cbor_item_t</a></td><td class="desc">The item handle </td></tr>
89<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__load__result.html" target="_self">cbor_load_result</a></td><td class="desc">High-level decoding result </td></tr>
90<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcbor__pair.html" target="_self">cbor_pair</a></td><td class="desc">Simple pair of items for use in maps </td></tr>
91</table>
92</div><!-- directory -->
93</div><!-- contents -->
94<!-- start footer part -->
95<hr class="footer"/><address class="footer"><small>
96Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
97<img class="footer" src="doxygen.png" alt="doxygen"/>
98</a> 1.8.12
99</small></address>
100</body>
101</html>
102