| <!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" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg::SchemaField Class 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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classiceberg_1_1SchemaField-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SchemaField Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A type combined with a name. |
| <a href="classiceberg_1_1SchemaField.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="schema__field_8h_source.html">schema_field.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::SchemaField:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1SchemaField.png" usemap="#iceberg::SchemaField_map" alt=""/> |
| <map id="iceberg::SchemaField_map" name="iceberg::SchemaField_map"> |
| <area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="0,0,149,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:af6c8ee3f0e8e4d56bae333686c4f30c1" id="r_af6c8ee3f0e8e4d56bae333686c4f30c1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SchemaField.html#af6c8ee3f0e8e4d56bae333686c4f30c1">SchemaField</a> (int32_t <a class="el" href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84">field_id</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5">name</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > <a class="el" href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f">type</a>, bool <a class="el" href="classiceberg_1_1SchemaField.html#aaee3e5fcc9a0fc3173cdcf1c00552df1">optional</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2">doc</a>={})</td></tr> |
| <tr class="memdesc:af6c8ee3f0e8e4d56bae333686c4f30c1"><td class="mdescLeft"> </td><td class="mdescRight">Construct a field. <br /></td></tr> |
| <tr class="separator:af6c8ee3f0e8e4d56bae333686c4f30c1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a23db912890745382ec78ccb6a93bce84" id="r_a23db912890745382ec78ccb6a93bce84"><td class="memItemLeft" align="right" valign="top"><a id="a23db912890745382ec78ccb6a93bce84" name="a23db912890745382ec78ccb6a93bce84"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>field_id</b> () const</td></tr> |
| <tr class="memdesc:a23db912890745382ec78ccb6a93bce84"><td class="mdescLeft"> </td><td class="mdescRight">Get the field ID. <br /></td></tr> |
| <tr class="separator:a23db912890745382ec78ccb6a93bce84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a733f14fa7ad1900137a97155329239e5" id="r_a733f14fa7ad1900137a97155329239e5"><td class="memItemLeft" align="right" valign="top"><a id="a733f14fa7ad1900137a97155329239e5" name="a733f14fa7ad1900137a97155329239e5"></a> |
| std::string_view </td><td class="memItemRight" valign="bottom"><b>name</b> () const</td></tr> |
| <tr class="memdesc:a733f14fa7ad1900137a97155329239e5"><td class="mdescLeft"> </td><td class="mdescRight">Get the field name. <br /></td></tr> |
| <tr class="separator:a733f14fa7ad1900137a97155329239e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9fbf59beb13cbb358fbce94d085ef53f" id="r_a9fbf59beb13cbb358fbce94d085ef53f"><td class="memItemLeft" align="right" valign="top"><a id="a9fbf59beb13cbb358fbce94d085ef53f" name="a9fbf59beb13cbb358fbce94d085ef53f"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > & </td><td class="memItemRight" valign="bottom"><b>type</b> () const</td></tr> |
| <tr class="memdesc:a9fbf59beb13cbb358fbce94d085ef53f"><td class="mdescLeft"> </td><td class="mdescRight">Get the field type. <br /></td></tr> |
| <tr class="separator:a9fbf59beb13cbb358fbce94d085ef53f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaee3e5fcc9a0fc3173cdcf1c00552df1" id="r_aaee3e5fcc9a0fc3173cdcf1c00552df1"><td class="memItemLeft" align="right" valign="top"><a id="aaee3e5fcc9a0fc3173cdcf1c00552df1" name="aaee3e5fcc9a0fc3173cdcf1c00552df1"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>optional</b> () const</td></tr> |
| <tr class="memdesc:aaee3e5fcc9a0fc3173cdcf1c00552df1"><td class="mdescLeft"> </td><td class="mdescRight">Get whether the field is optional. <br /></td></tr> |
| <tr class="separator:aaee3e5fcc9a0fc3173cdcf1c00552df1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad992c1fcedc2d56244138f477efe21f2" id="r_ad992c1fcedc2d56244138f477efe21f2"><td class="memItemLeft" align="right" valign="top"><a id="ad992c1fcedc2d56244138f477efe21f2" name="ad992c1fcedc2d56244138f477efe21f2"></a> |
| std::string_view </td><td class="memItemRight" valign="bottom"><b>doc</b> () const</td></tr> |
| <tr class="memdesc:ad992c1fcedc2d56244138f477efe21f2"><td class="mdescLeft"> </td><td class="mdescRight">Get the field documentation. <br /></td></tr> |
| <tr class="separator:ad992c1fcedc2d56244138f477efe21f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2268e045b8212387bb2d5e1e75e8d0e5" id="r_a2268e045b8212387bb2d5e1e75e8d0e5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SchemaField.html#a2268e045b8212387bb2d5e1e75e8d0e5">ToString</a> () const override</td></tr> |
| <tr class="memdesc:a2268e045b8212387bb2d5e1e75e8d0e5"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:a2268e045b8212387bb2d5e1e75e8d0e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f9bf0871958e9784fb7958e2e171647" id="r_a9f9bf0871958e9784fb7958e2e171647"><td class="memItemLeft" align="right" valign="top"><a id="a9f9bf0871958e9784fb7958e2e171647" name="a9f9bf0871958e9784fb7958e2e171647"></a> |
| Status </td><td class="memItemRight" valign="bottom"><b>Validate</b> () const</td></tr> |
| <tr class="separator:a9f9bf0871958e9784fb7958e2e171647"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5942fc853fa4a54966c324df07f10e10" id="r_a5942fc853fa4a54966c324df07f10e10"><td class="memItemLeft" align="right" valign="top"><a id="a5942fc853fa4a54966c324df07f10e10" name="a5942fc853fa4a54966c324df07f10e10"></a> |
| <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><b>AsRequired</b> () const</td></tr> |
| <tr class="separator:a5942fc853fa4a54966c324df07f10e10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a766c8a0a5c7d95faada5a6279612589b" id="r_a766c8a0a5c7d95faada5a6279612589b"><td class="memItemLeft" align="right" valign="top"><a id="a766c8a0a5c7d95faada5a6279612589b" name="a766c8a0a5c7d95faada5a6279612589b"></a> |
| <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><b>AsOptional</b> () const</td></tr> |
| <tr class="separator:a766c8a0a5c7d95faada5a6279612589b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0c8382f6e164b76f45e4b4c26028a872" id="r_a0c8382f6e164b76f45e4b4c26028a872"><td class="memItemLeft" align="right" valign="top"><a id="a0c8382f6e164b76f45e4b4c26028a872" name="a0c8382f6e164b76f45e4b4c26028a872"></a> |
| static <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><b>MakeOptional</b> (int32_t <a class="el" href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84">field_id</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5">name</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > <a class="el" href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f">type</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2">doc</a>={})</td></tr> |
| <tr class="memdesc:a0c8382f6e164b76f45e4b4c26028a872"><td class="mdescLeft"> </td><td class="mdescRight">Construct an optional (nullable) field. <br /></td></tr> |
| <tr class="separator:a0c8382f6e164b76f45e4b4c26028a872"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ad7baa4dedd37e2f699a2f32deef942" id="r_a4ad7baa4dedd37e2f699a2f32deef942"><td class="memItemLeft" align="right" valign="top"><a id="a4ad7baa4dedd37e2f699a2f32deef942" name="a4ad7baa4dedd37e2f699a2f32deef942"></a> |
| static <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> </td><td class="memItemRight" valign="bottom"><b>MakeRequired</b> (int32_t <a class="el" href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84">field_id</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5">name</a>, std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > <a class="el" href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f">type</a>, std::string_view <a class="el" href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2">doc</a>={})</td></tr> |
| <tr class="memdesc:a4ad7baa4dedd37e2f699a2f32deef942"><td class="mdescLeft"> </td><td class="mdescRight">Construct a required (non-null) field. <br /></td></tr> |
| <tr class="separator:a4ad7baa4dedd37e2f699a2f32deef942"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a6b2bb9065eb2b5434c4ec7c59fa2777e" id="r_a6b2bb9065eb2b5434c4ec7c59fa2777e"><td class="memItemLeft" align="right" valign="top"><a id="a6b2bb9065eb2b5434c4ec7c59fa2777e" name="a6b2bb9065eb2b5434c4ec7c59fa2777e"></a> |
| static constexpr int32_t </td><td class="memItemRight" valign="bottom"><b>kInvalidFieldId</b> = -1</td></tr> |
| <tr class="separator:a6b2bb9065eb2b5434c4ec7c59fa2777e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a02fc28490c65b5033a44315aa57c31c1" id="r_a02fc28490c65b5033a44315aa57c31c1"><td class="memItemLeft" align="right" valign="top"><a id="a02fc28490c65b5033a44315aa57c31c1" name="a02fc28490c65b5033a44315aa57c31c1"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> &lhs, const <a class="el" href="classiceberg_1_1SchemaField.html">SchemaField</a> &rhs)</td></tr> |
| <tr class="separator:a02fc28490c65b5033a44315aa57c31c1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A type combined with a name. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="af6c8ee3f0e8e4d56bae333686c4f30c1" name="af6c8ee3f0e8e4d56bae333686c4f30c1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af6c8ee3f0e8e4d56bae333686c4f30c1">◆ </a></span>SchemaField()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::SchemaField::SchemaField </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>field_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Type.html">Type</a> > </td> |
| <td class="paramname"><em>type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>optional</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>doc</em> = <code>{}</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a field. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">field_id</td><td>The field ID. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The field name. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The field type. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">optional</td><td>Whether values of this field are required or nullable. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">doc</td><td>Optional documentation string for the field. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2268e045b8212387bb2d5e1e75e8d0e5" name="a2268e045b8212387bb2d5e1e75e8d0e5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2268e045b8212387bb2d5e1e75e8d0e5">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string iceberg::SchemaField::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a user-readable string representation. </p> |
| |
| <p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/<a class="el" href="schema__field_8h_source.html">schema_field.h</a></li> |
| <li>iceberg/<b>schema_field.cc</b></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
