| <!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/schema_field.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">schema_field.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="schema__field_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="formattable_8h.html">iceberg/util/formattable.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="foldopen" id="foldopen00039" data-start="{" data-end="};"> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html"> 39</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a> {</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> int32_t kInvalidFieldId = -1;</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a78dabd25339461a8fc79eacb7ea76fcf"> 51</a></span> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a78dabd25339461a8fc79eacb7ea76fcf">SchemaField</a>(int32_t field_id, std::string_view name, std::shared_ptr<Type> type,</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">bool</span> optional, std::string_view doc = {},</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> std::shared_ptr<const Literal> initial_default = <span class="keyword">nullptr</span>,</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> std::shared_ptr<const Literal> write_default = <span class="keyword">nullptr</span>);</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#ad3918b8d6e7f0aeb2e9f9a08d6d0a0c8"> 57</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#ad3918b8d6e7f0aeb2e9f9a08d6d0a0c8">MakeOptional</a>(int32_t field_id, std::string_view name,</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> std::shared_ptr<Type> type, std::string_view doc = {});</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a88a17d14091bbebfeb2d6fdce2e0e02a"> 60</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a88a17d14091bbebfeb2d6fdce2e0e02a">MakeRequired</a>(int32_t field_id, std::string_view name,</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> std::shared_ptr<Type> type, std::string_view doc = {});</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a0c74e7c99bfff14c6efcfcc16b84f420"> 64</a></span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0c74e7c99bfff14c6efcfcc16b84f420">WithName</a>(std::string_view name) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a60c983304ab07b929d14a854c87d3262"> 67</a></span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a60c983304ab07b929d14a854c87d3262">WithType</a>(std::shared_ptr<Type> type) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a3a6033fd85502c3c42e0232f5f573b49"> 70</a></span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a3a6033fd85502c3c42e0232f5f573b49">WithDoc</a>(std::string_view doc) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a0042e279112c4a2779ad11cd4016f2b7"> 73</a></span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0042e279112c4a2779ad11cd4016f2b7">WithInitialDefault</a>(std::shared_ptr<const Literal> initial_default) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a46127ae5cc66bf75ae705b35172febb3"> 76</a></span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a46127ae5cc66bf75ae705b35172febb3">WithWriteDefault</a>(std::shared_ptr<const Literal> write_default) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#ab15679b5e9acdfa58f00cf3d11962785"> 79</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<Literal></a> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#ab15679b5e9acdfa58f00cf3d11962785">CastDefaultValue</a>(</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Literal.html">Literal</a>& value, <span class="keyword">const</span> std::shared_ptr<PrimitiveType>& target_type);</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84"> 83</a></span> int32_t <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84">field_id</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5"> 86</a></span> std::string_view <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5">name</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f"> 89</a></span> <span class="keyword">const</span> std::shared_ptr<Type>& <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f">type</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#aaee3e5fcc9a0fc3173cdcf1c00552df1"> 92</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1SchemaField.html#aaee3e5fcc9a0fc3173cdcf1c00552df1">optional</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2"> 95</a></span> std::string_view <a class="code hl_function" href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2">doc</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#ae93f65eb17f03377646a46268138054c"> 98</a></span> <span class="keyword">const</span> std::shared_ptr<const Literal>& <a class="code hl_function" href="classiceberg_1_1SchemaField.html#ae93f65eb17f03377646a46268138054c">initial_default</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a0d46458db6e6ff1df850dc5a815ccdb7"> 101</a></span> <span class="keyword">const</span> std::shared_ptr<const Literal>& <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a0d46458db6e6ff1df850dc5a815ccdb7">write_default</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classiceberg_1_1SchemaField.html#a2268e045b8212387bb2d5e1e75e8d0e5"> 103</a></span> std::string <a class="code hl_function" href="classiceberg_1_1SchemaField.html#a2268e045b8212387bb2d5e1e75e8d0e5">ToString</a>() <span class="keyword">const override</span>;</div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> Status Validate() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div> |
| <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">friend</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a>& lhs, <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a>& rhs) {</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keywordflow">return</span> lhs.Equals(rhs);</div> |
| <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> }</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <a class="code hl_class" href="classiceberg_1_1SchemaField.html">SchemaField</a> AsRequired()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">auto</span> copy = *<span class="keyword">this</span>;</div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> copy.optional_ = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordflow">return</span> copy;</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> }</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> SchemaField AsOptional()<span class="keyword"> const </span>{</div> |
| <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">auto</span> copy = *<span class="keyword">this</span>;</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> copy.optional_ = <span class="keyword">true</span>;</div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">return</span> copy;</div> |
| <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> }</div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordtype">bool</span> Equals(<span class="keyword">const</span> SchemaField& other) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> int32_t field_id_;</div> |
| <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> std::string name_;</div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> std::shared_ptr<Type> type_;</div> |
| <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">bool</span> optional_;</div> |
| <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> std::string doc_;</div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> std::shared_ptr<const Literal> initial_default_;</div> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> std::shared_ptr<const Literal> write_default_;</div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span>};</div> |
| </div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div> |
| <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1Literal_html"><div class="ttname"><a href="classiceberg_1_1Literal.html">iceberg::Literal</a></div><div class="ttdoc">Literal is a literal value that is associated with a primitive type.</div><div class="ttdef"><b>Definition</b> literal.h:42</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html"><div class="ttname"><a href="classiceberg_1_1SchemaField.html">iceberg::SchemaField</a></div><div class="ttdoc">A type combined with a name.</div><div class="ttdef"><b>Definition</b> schema_field.h:39</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a0042e279112c4a2779ad11cd4016f2b7"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a0042e279112c4a2779ad11cd4016f2b7">iceberg::SchemaField::WithInitialDefault</a></div><div class="ttdeci">SchemaField WithInitialDefault(std::shared_ptr< const Literal > initial_default) const</div><div class="ttdoc">Return a copy with a new initial-default.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a0c74e7c99bfff14c6efcfcc16b84f420"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a0c74e7c99bfff14c6efcfcc16b84f420">iceberg::SchemaField::WithName</a></div><div class="ttdeci">SchemaField WithName(std::string_view name) const</div><div class="ttdoc">Return a copy with a new name.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a0d46458db6e6ff1df850dc5a815ccdb7"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a0d46458db6e6ff1df850dc5a815ccdb7">iceberg::SchemaField::write_default</a></div><div class="ttdeci">const std::shared_ptr< const Literal > & write_default() const</div><div class="ttdoc">Get the v3 write-default, or null if absent.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a2268e045b8212387bb2d5e1e75e8d0e5"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a2268e045b8212387bb2d5e1e75e8d0e5">iceberg::SchemaField::ToString</a></div><div class="ttdeci">std::string ToString() const override</div><div class="ttdoc">Get a user-readable string representation.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a23db912890745382ec78ccb6a93bce84"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a23db912890745382ec78ccb6a93bce84">iceberg::SchemaField::field_id</a></div><div class="ttdeci">int32_t field_id() const</div><div class="ttdoc">Get the field ID.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a3a6033fd85502c3c42e0232f5f573b49"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a3a6033fd85502c3c42e0232f5f573b49">iceberg::SchemaField::WithDoc</a></div><div class="ttdeci">SchemaField WithDoc(std::string_view doc) const</div><div class="ttdoc">Return a copy with new documentation.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a46127ae5cc66bf75ae705b35172febb3"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a46127ae5cc66bf75ae705b35172febb3">iceberg::SchemaField::WithWriteDefault</a></div><div class="ttdeci">SchemaField WithWriteDefault(std::shared_ptr< const Literal > write_default) const</div><div class="ttdoc">Return a copy with a new write-default.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a60c983304ab07b929d14a854c87d3262"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a60c983304ab07b929d14a854c87d3262">iceberg::SchemaField::WithType</a></div><div class="ttdeci">SchemaField WithType(std::shared_ptr< Type > type) const</div><div class="ttdoc">Return a copy with a new type.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a733f14fa7ad1900137a97155329239e5"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a733f14fa7ad1900137a97155329239e5">iceberg::SchemaField::name</a></div><div class="ttdeci">std::string_view name() const</div><div class="ttdoc">Get the field name.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a78dabd25339461a8fc79eacb7ea76fcf"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a78dabd25339461a8fc79eacb7ea76fcf">iceberg::SchemaField::SchemaField</a></div><div class="ttdeci">SchemaField(int32_t field_id, std::string_view name, std::shared_ptr< Type > type, bool optional, std::string_view doc={}, std::shared_ptr< const Literal > initial_default=nullptr, std::shared_ptr< const Literal > write_default=nullptr)</div><div class="ttdoc">Construct a field.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a88a17d14091bbebfeb2d6fdce2e0e02a"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a88a17d14091bbebfeb2d6fdce2e0e02a">iceberg::SchemaField::MakeRequired</a></div><div class="ttdeci">static SchemaField MakeRequired(int32_t field_id, std::string_view name, std::shared_ptr< Type > type, std::string_view doc={})</div><div class="ttdoc">Construct a required (non-null) field.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_a9fbf59beb13cbb358fbce94d085ef53f"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#a9fbf59beb13cbb358fbce94d085ef53f">iceberg::SchemaField::type</a></div><div class="ttdeci">const std::shared_ptr< Type > & type() const</div><div class="ttdoc">Get the field type.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_aaee3e5fcc9a0fc3173cdcf1c00552df1"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#aaee3e5fcc9a0fc3173cdcf1c00552df1">iceberg::SchemaField::optional</a></div><div class="ttdeci">bool optional() const</div><div class="ttdoc">Get whether the field is optional.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_ab15679b5e9acdfa58f00cf3d11962785"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#ab15679b5e9acdfa58f00cf3d11962785">iceberg::SchemaField::CastDefaultValue</a></div><div class="ttdeci">static Result< Literal > CastDefaultValue(const Literal &value, const std::shared_ptr< PrimitiveType > &target_type)</div><div class="ttdoc">Cast a default literal to a field type.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_ad3918b8d6e7f0aeb2e9f9a08d6d0a0c8"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#ad3918b8d6e7f0aeb2e9f9a08d6d0a0c8">iceberg::SchemaField::MakeOptional</a></div><div class="ttdeci">static SchemaField MakeOptional(int32_t field_id, std::string_view name, std::shared_ptr< Type > type, std::string_view doc={})</div><div class="ttdoc">Construct an optional (nullable) field.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_ad992c1fcedc2d56244138f477efe21f2"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#ad992c1fcedc2d56244138f477efe21f2">iceberg::SchemaField::doc</a></div><div class="ttdeci">std::string_view doc() const</div><div class="ttdoc">Get the field documentation.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1SchemaField_html_ae93f65eb17f03377646a46268138054c"><div class="ttname"><a href="classiceberg_1_1SchemaField.html#ae93f65eb17f03377646a46268138054c">iceberg::SchemaField::initial_default</a></div><div class="ttdeci">const std::shared_ptr< const Literal > & initial_default() const</div><div class="ttdoc">Get the v3 initial-default, or null if absent.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1util_1_1Formattable_html"><div class="ttname"><a href="classiceberg_1_1util_1_1Formattable.html">iceberg::util::Formattable</a></div><div class="ttdoc">Interface for objects that can be formatted via std::format.</div><div class="ttdef"><b>Definition</b> formattable.h:36</div></div> |
| <div class="ttc" id="aformattable_8h_html"><div class="ttname"><a href="formattable_8h.html">formattable.h</a></div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></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> |
