3party/protobuf-c
0
0
Fork 0
mirror of https://github.com/protobuf-c/protobuf-c.git synced 2025-01-14 01:07:57 +08:00
Code Issues Projects Releases Wiki Activity
protobuf-c/structProtobufCFieldDescriptor.html

316 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>protobuf-c: ProtobufCFieldDescriptor Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">protobuf-c
&#160;<span id="projectnumber">1.3.3</span>
</div>
<div id="projectbrief">Protocol Buffers implementation in C</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structProtobufCFieldDescriptor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ProtobufCFieldDescriptor Struct Reference<div class="ingroups"><a class="el" href="group__api.html">Public API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Describes a single field in a message.
<a href="structProtobufCFieldDescriptor.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a638079ed9058af372886d36d07f34026"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a638079ed9058af372886d36d07f34026">name</a></td></tr>
<tr class="memdesc:a638079ed9058af372886d36d07f34026"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the field as given in the .proto file. <a href="structProtobufCFieldDescriptor.html#a638079ed9058af372886d36d07f34026">More...</a><br /></td></tr>
<tr class="separator:a638079ed9058af372886d36d07f34026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82112e379e82f918bee30fbc642465f9"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a82112e379e82f918bee30fbc642465f9">id</a></td></tr>
<tr class="memdesc:a82112e379e82f918bee30fbc642465f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag value of the field as given in the .proto file. <a href="structProtobufCFieldDescriptor.html#a82112e379e82f918bee30fbc642465f9">More...</a><br /></td></tr>
<tr class="separator:a82112e379e82f918bee30fbc642465f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e372282ca68b6518942ad7f2f296a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api.html#ga5ec2e3fd5bbe4c5f6a64b06b7425d0e5">ProtobufCLabel</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a99e372282ca68b6518942ad7f2f296a9">label</a></td></tr>
<tr class="memdesc:a99e372282ca68b6518942ad7f2f296a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the field is <code>REQUIRED</code>, <code>OPTIONAL</code>, or <code>REPEATED</code>. <a href="structProtobufCFieldDescriptor.html#a99e372282ca68b6518942ad7f2f296a9">More...</a><br /></td></tr>
<tr class="separator:a99e372282ca68b6518942ad7f2f296a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a653c35028fae85d37f859b4f43a76375"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api.html#ga784625188e935a74bc4577297b8c6802">ProtobufCType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a653c35028fae85d37f859b4f43a76375">type</a></td></tr>
<tr class="memdesc:a653c35028fae85d37f859b4f43a76375"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of the field. <a href="structProtobufCFieldDescriptor.html#a653c35028fae85d37f859b4f43a76375">More...</a><br /></td></tr>
<tr class="separator:a653c35028fae85d37f859b4f43a76375"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1bcfe1a527b4137579dcc7c7ea34412"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#ad1bcfe1a527b4137579dcc7c7ea34412">quantifier_offset</a></td></tr>
<tr class="memdesc:ad1bcfe1a527b4137579dcc7c7ea34412"><td class="mdescLeft">&#160;</td><td class="mdescRight">The offset in bytes of the message's C structure's quantifier field (the <code>has_MEMBER</code> field for optional members or the <code>n_MEMBER</code> field for repeated members or the case enum for oneofs). <a href="structProtobufCFieldDescriptor.html#ad1bcfe1a527b4137579dcc7c7ea34412">More...</a><br /></td></tr>
<tr class="separator:ad1bcfe1a527b4137579dcc7c7ea34412"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe74a7bf70a22129e50cb080fd020d56"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#afe74a7bf70a22129e50cb080fd020d56">offset</a></td></tr>
<tr class="memdesc:afe74a7bf70a22129e50cb080fd020d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">The offset in bytes into the message's C structure for the member itself. <a href="structProtobufCFieldDescriptor.html#afe74a7bf70a22129e50cb080fd020d56">More...</a><br /></td></tr>
<tr class="separator:afe74a7bf70a22129e50cb080fd020d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae52d010d4a0c1e460e7231100213149f"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#ae52d010d4a0c1e460e7231100213149f">descriptor</a></td></tr>
<tr class="memdesc:ae52d010d4a0c1e460e7231100213149f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A type-specific descriptor. <a href="structProtobufCFieldDescriptor.html#ae52d010d4a0c1e460e7231100213149f">More...</a><br /></td></tr>
<tr class="separator:ae52d010d4a0c1e460e7231100213149f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f1c521cb8eba9ae552b4cb16e834a02"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a2f1c521cb8eba9ae552b4cb16e834a02">default_value</a></td></tr>
<tr class="memdesc:a2f1c521cb8eba9ae552b4cb16e834a02"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value for this field, if defined. <a href="structProtobufCFieldDescriptor.html#a2f1c521cb8eba9ae552b4cb16e834a02">More...</a><br /></td></tr>
<tr class="separator:a2f1c521cb8eba9ae552b4cb16e834a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8f4ec4a335375b3fe21eaeb87a94d7c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#af8f4ec4a335375b3fe21eaeb87a94d7c">flags</a></td></tr>
<tr class="memdesc:af8f4ec4a335375b3fe21eaeb87a94d7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A flag word. <a href="structProtobufCFieldDescriptor.html#af8f4ec4a335375b3fe21eaeb87a94d7c">More...</a><br /></td></tr>
<tr class="separator:af8f4ec4a335375b3fe21eaeb87a94d7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4edeb30533971d641054c40424a22f37"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a4edeb30533971d641054c40424a22f37">reserved_flags</a></td></tr>
<tr class="memdesc:a4edeb30533971d641054c40424a22f37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future use. <a href="structProtobufCFieldDescriptor.html#a4edeb30533971d641054c40424a22f37">More...</a><br /></td></tr>
<tr class="separator:a4edeb30533971d641054c40424a22f37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97f3fefb28e3cc5486117cf240d0d5ba"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a97f3fefb28e3cc5486117cf240d0d5ba">reserved2</a></td></tr>
<tr class="memdesc:a97f3fefb28e3cc5486117cf240d0d5ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future use. <a href="structProtobufCFieldDescriptor.html#a97f3fefb28e3cc5486117cf240d0d5ba">More...</a><br /></td></tr>
<tr class="separator:a97f3fefb28e3cc5486117cf240d0d5ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97c99778b7881d54b8e3cd8cdac5bb2d"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structProtobufCFieldDescriptor.html#a97c99778b7881d54b8e3cd8cdac5bb2d">reserved3</a></td></tr>
<tr class="memdesc:a97c99778b7881d54b8e3cd8cdac5bb2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future use. <a href="structProtobufCFieldDescriptor.html#a97c99778b7881d54b8e3cd8cdac5bb2d">More...</a><br /></td></tr>
<tr class="separator:a97c99778b7881d54b8e3cd8cdac5bb2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes a single field in a message. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a638079ed9058af372886d36d07f34026"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a638079ed9058af372886d36d07f34026">&#9670;&nbsp;</a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ProtobufCFieldDescriptor::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the field as given in the .proto file. </p>
</div>
</div>
<a id="a82112e379e82f918bee30fbc642465f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82112e379e82f918bee30fbc642465f9">&#9670;&nbsp;</a></span>id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ProtobufCFieldDescriptor::id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tag value of the field as given in the .proto file. </p>
</div>
</div>
<a id="a99e372282ca68b6518942ad7f2f296a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e372282ca68b6518942ad7f2f296a9">&#9670;&nbsp;</a></span>label</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api.html#ga5ec2e3fd5bbe4c5f6a64b06b7425d0e5">ProtobufCLabel</a> ProtobufCFieldDescriptor::label</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether the field is <code>REQUIRED</code>, <code>OPTIONAL</code>, or <code>REPEATED</code>. </p>
</div>
</div>
<a id="a653c35028fae85d37f859b4f43a76375"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a653c35028fae85d37f859b4f43a76375">&#9670;&nbsp;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__api.html#ga784625188e935a74bc4577297b8c6802">ProtobufCType</a> ProtobufCFieldDescriptor::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of the field. </p>
</div>
</div>
<a id="ad1bcfe1a527b4137579dcc7c7ea34412"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1bcfe1a527b4137579dcc7c7ea34412">&#9670;&nbsp;</a></span>quantifier_offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ProtobufCFieldDescriptor::quantifier_offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The offset in bytes of the message's C structure's quantifier field (the <code>has_MEMBER</code> field for optional members or the <code>n_MEMBER</code> field for repeated members or the case enum for oneofs). </p>
</div>
</div>
<a id="afe74a7bf70a22129e50cb080fd020d56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe74a7bf70a22129e50cb080fd020d56">&#9670;&nbsp;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ProtobufCFieldDescriptor::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The offset in bytes into the message's C structure for the member itself. </p>
</div>
</div>
<a id="ae52d010d4a0c1e460e7231100213149f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae52d010d4a0c1e460e7231100213149f">&#9670;&nbsp;</a></span>descriptor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* ProtobufCFieldDescriptor::descriptor</td>
</tr>
</table>
</div><div class="memdoc">
<p>A type-specific descriptor. </p>
<p>If <code>type</code> is <code>PROTOBUF_C_TYPE_ENUM</code>, then <code>descriptor</code> points to the corresponding <code><a class="el" href="structProtobufCEnumDescriptor.html" title="Describes an enumeration as a whole, with all of its values.">ProtobufCEnumDescriptor</a></code>.</p>
<p>If <code>type</code> is <code>PROTOBUF_C_TYPE_MESSAGE</code>, then <code>descriptor</code> points to the corresponding <code><a class="el" href="structProtobufCMessageDescriptor.html" title="Describes a message.">ProtobufCMessageDescriptor</a></code>.</p>
<p>Otherwise this field is NULL. </p>
</div>
</div>
<a id="a2f1c521cb8eba9ae552b4cb16e834a02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f1c521cb8eba9ae552b4cb16e834a02">&#9670;&nbsp;</a></span>default_value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* ProtobufCFieldDescriptor::default_value</td>
</tr>
</table>
</div><div class="memdoc">
<p>The default value for this field, if defined. </p>
<p>May be NULL. </p>
</div>
</div>
<a id="af8f4ec4a335375b3fe21eaeb87a94d7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8f4ec4a335375b3fe21eaeb87a94d7c">&#9670;&nbsp;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ProtobufCFieldDescriptor::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>A flag word. </p>
<p>Zero or more of the bits defined in the <code>ProtobufCFieldFlag</code> enum may be set. </p>
</div>
</div>
<a id="a4edeb30533971d641054c40424a22f37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4edeb30533971d641054c40424a22f37">&#9670;&nbsp;</a></span>reserved_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ProtobufCFieldDescriptor::reserved_flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use. </p>
</div>
</div>
<a id="a97f3fefb28e3cc5486117cf240d0d5ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97f3fefb28e3cc5486117cf240d0d5ba">&#9670;&nbsp;</a></span>reserved2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ProtobufCFieldDescriptor::reserved2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use. </p>
</div>
</div>
<a id="a97c99778b7881d54b8e3cd8cdac5bb2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97c99778b7881d54b8e3cd8cdac5bb2d">&#9670;&nbsp;</a></span>reserved3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ProtobufCFieldDescriptor::reserved3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structProtobufCFieldDescriptor.html">ProtobufCFieldDescriptor</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink