| <!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/util/uuid.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><li class="navelem"><a class="el" href="dir_6a066966226cd78a6111c1015733de08.html">util</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">uuid.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="uuid_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="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <array></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <span></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</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="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="formattable_8h.html">iceberg/util/formattable.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="foldopen" id="foldopen00036" data-start="{" data-end="};"> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html"> 36</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1util_1_1Formattable.html">util::Formattable</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a>() = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">constexpr</span> <span class="keyword">static</span> <span class="keywordtype">size_t</span> kLength = 16;</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a>(std::array<uint8_t, kLength> data);</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#adaa4a5f380a097e6fe223dbaca17268a"> 44</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a> <a class="code hl_function" href="classiceberg_1_1Uuid.html#adaa4a5f380a097e6fe223dbaca17268a">GenerateV4</a>();</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#acc578a98c5f9bd14dfd8fe29a2811d3d"> 47</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a> <a class="code hl_function" href="classiceberg_1_1Uuid.html#acc578a98c5f9bd14dfd8fe29a2811d3d">GenerateV7</a>();</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#a895390b615347871a29329bf279cec4b"> 57</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a> <a class="code hl_function" href="classiceberg_1_1Uuid.html#a895390b615347871a29329bf279cec4b">GenerateV7</a>(uint64_t unix_ts_ms);</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#a7bc40968d6a60335e4e8c2bb1e54c7e8"> 60</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<Uuid></a> <a class="code hl_function" href="classiceberg_1_1Uuid.html#a7bc40968d6a60335e4e8c2bb1e54c7e8">FromString</a>(std::string_view str);</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#a52d98c613d6485ffab46038b3e960c22"> 63</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<Uuid></a> <a class="code hl_function" href="classiceberg_1_1Uuid.html#a52d98c613d6485ffab46038b3e960c22">FromBytes</a>(std::span<const uint8_t> bytes);</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#ada159831eb6d5ec84bcd7e4ccf6f4219"> 66</a></span> std::span<const uint8_t> <a class="code hl_function" href="classiceberg_1_1Uuid.html#ada159831eb6d5ec84bcd7e4ccf6f4219">bytes</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> data_; }</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#ab42b2c99ed63404a12dc22f9b5c54646"> 72</a></span> uint8_t <a class="code hl_function" href="classiceberg_1_1Uuid.html#ab42b2c99ed63404a12dc22f9b5c54646">operator[]</a>(<span class="keywordtype">size_t</span> index) <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classiceberg_1_1Uuid.html#a4985d4b1a1226e78aa0bc05cba49211b"> 75</a></span> std::string <a class="code hl_function" href="classiceberg_1_1Uuid.html#a4985d4b1a1226e78aa0bc05cba49211b">ToString</a>() <span class="keyword">const override</span>;</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</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_1Uuid.html">Uuid</a>& lhs, <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Uuid.html">Uuid</a>& rhs) {</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">return</span> lhs.data_ == rhs.data_;</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> }</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> int64_t high_bits() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> int64_t low_bits() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> std::array<uint8_t, kLength> data_;</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>};</div> |
| </div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html"><div class="ttname"><a href="classiceberg_1_1Uuid.html">iceberg::Uuid</a></div><div class="ttdef"><b>Definition</b> uuid.h:36</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_a4985d4b1a1226e78aa0bc05cba49211b"><div class="ttname"><a href="classiceberg_1_1Uuid.html#a4985d4b1a1226e78aa0bc05cba49211b">iceberg::Uuid::ToString</a></div><div class="ttdeci">std::string ToString() const override</div><div class="ttdoc">Convert the UUID to a string in standard format.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_a52d98c613d6485ffab46038b3e960c22"><div class="ttname"><a href="classiceberg_1_1Uuid.html#a52d98c613d6485ffab46038b3e960c22">iceberg::Uuid::FromBytes</a></div><div class="ttdeci">static Result< Uuid > FromBytes(std::span< const uint8_t > bytes)</div><div class="ttdoc">Create a UUID from a 16-byte array.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_a7bc40968d6a60335e4e8c2bb1e54c7e8"><div class="ttname"><a href="classiceberg_1_1Uuid.html#a7bc40968d6a60335e4e8c2bb1e54c7e8">iceberg::Uuid::FromString</a></div><div class="ttdeci">static Result< Uuid > FromString(std::string_view str)</div><div class="ttdoc">Create a UUID from a string in standard format.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_a895390b615347871a29329bf279cec4b"><div class="ttname"><a href="classiceberg_1_1Uuid.html#a895390b615347871a29329bf279cec4b">iceberg::Uuid::GenerateV7</a></div><div class="ttdeci">static Uuid GenerateV7(uint64_t unix_ts_ms)</div><div class="ttdoc">Generate UUID version 7 per RFC 9562, with the given timestamp.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_ab42b2c99ed63404a12dc22f9b5c54646"><div class="ttname"><a href="classiceberg_1_1Uuid.html#ab42b2c99ed63404a12dc22f9b5c54646">iceberg::Uuid::operator[]</a></div><div class="ttdeci">uint8_t operator[](size_t index) const</div><div class="ttdoc">Access individual bytes of the UUID.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_acc578a98c5f9bd14dfd8fe29a2811d3d"><div class="ttname"><a href="classiceberg_1_1Uuid.html#acc578a98c5f9bd14dfd8fe29a2811d3d">iceberg::Uuid::GenerateV7</a></div><div class="ttdeci">static Uuid GenerateV7()</div><div class="ttdoc">Generate UUID version 7 per RFC 9562, with the current timestamp.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_ada159831eb6d5ec84bcd7e4ccf6f4219"><div class="ttname"><a href="classiceberg_1_1Uuid.html#ada159831eb6d5ec84bcd7e4ccf6f4219">iceberg::Uuid::bytes</a></div><div class="ttdeci">std::span< const uint8_t > bytes() const</div><div class="ttdoc">Get the raw bytes of the UUID.</div><div class="ttdef"><b>Definition</b> uuid.h:66</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Uuid_html_adaa4a5f380a097e6fe223dbaca17268a"><div class="ttname"><a href="classiceberg_1_1Uuid.html#adaa4a5f380a097e6fe223dbaca17268a">iceberg::Uuid::GenerateV4</a></div><div class="ttdeci">static Uuid GenerateV4()</div><div class="ttdoc">Generate a random UUID (version 4).</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><!-- 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> |
