| <!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>Paimon-cpp: /home/runner/work/paimon-cpp/paimon-cpp/include/paimon/commit_message.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">Paimon-cpp |
| </div> |
| <div id="projectbrief">A high-performance C++ implementation of Apache Paimon</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d5ce83a91c1ada980bd794a9f3314520.html">paimon</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">commit_message.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="commit__message_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 <cstdint></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <vector></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="result_8h.html">paimon/result.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="type__fwd_8h.html">paimon/type_fwd.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="visibility_8h.html">paimon/visibility.h</a>"</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="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">class </span>CommitMessageSerializer;</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">class </span>MemoryPool;</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment">// TODO(yonghao.fyh): to add some statistics of write (e.g., write bytes)</span></div> |
| <div class="foldopen" id="foldopen00042" data-start="{" data-end="};"> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html"> 42</a></span><span class="keyword">class </span>PAIMON_EXPORT <a class="code hl_class" href="classpaimon_1_1_commit_message.html">CommitMessage</a> {</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a9159f8ad92ea44772c23c79520314604"> 45</a></span> <span class="keyword">static</span> int32_t <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a9159f8ad92ea44772c23c79520314604">CurrentVersion</a>();</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a632e176063fab576732c6241c6bd6856"> 47</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a632e176063fab576732c6241c6bd6856">~CommitMessage</a>();</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#aef2ceb513f93eb8ff64b67626bd8ce89"> 55</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::string></a> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#aef2ceb513f93eb8ff64b67626bd8ce89">Serialize</a>(<span class="keyword">const</span> std::shared_ptr<CommitMessage>& commit_message,</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">const</span> std::shared_ptr<MemoryPool>& pool);</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a3658330e724ddae3ac54be4715907e8f"> 63</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::string></a> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a3658330e724ddae3ac54be4715907e8f">SerializeList</a>(</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">const</span> std::vector<std::shared_ptr<CommitMessage>>& commit_messages,</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">const</span> std::shared_ptr<MemoryPool>& pool);</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a13c70379bb2ce34af537b85a5f4b7270"> 74</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::shared_ptr<CommitMessage></a>> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a13c70379bb2ce34af537b85a5f4b7270">Deserialize</a>(</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> int32_t version, <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, int32_t length,</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">const</span> std::shared_ptr<MemoryPool>& pool);</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a452a4d820731446cd0040ae984dfd0e4"> 86</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::vector<std::shared_ptr<CommitMessage></a>>> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a452a4d820731446cd0040ae984dfd0e4">DeserializeList</a>(</div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> int32_t version, <span class="keyword">const</span> <span class="keywordtype">char</span>* buffer, int32_t length,</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">const</span> std::shared_ptr<MemoryPool>& pool);</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classpaimon_1_1_commit_message.html#a03619d672e0ddc55d55b3da2b7e42d5a"> 94</a></span> <span class="keyword">static</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::string></a> <a class="code hl_function" href="classpaimon_1_1_commit_message.html#a03619d672e0ddc55d55b3da2b7e42d5a">ToDebugString</a>(<span class="keyword">const</span> std::shared_ptr<CommitMessage>& commit_message);</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>};</div> |
| </div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span>} <span class="comment">// namespace paimon</span></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html"><div class="ttname"><a href="classpaimon_1_1_commit_message.html">paimon::CommitMessage</a></div><div class="ttdoc">Commit message for partition and bucket.</div><div class="ttdef"><b>Definition</b> commit_message.h:42</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a03619d672e0ddc55d55b3da2b7e42d5a"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a03619d672e0ddc55d55b3da2b7e42d5a">paimon::CommitMessage::ToDebugString</a></div><div class="ttdeci">static Result< std::string > ToDebugString(const std::shared_ptr< CommitMessage > &commit_message)</div><div class="ttdoc">Converts a commit message to a human-readable debug string.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a13c70379bb2ce34af537b85a5f4b7270"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a13c70379bb2ce34af537b85a5f4b7270">paimon::CommitMessage::Deserialize</a></div><div class="ttdeci">static Result< std::shared_ptr< CommitMessage > > Deserialize(int32_t version, const char *buffer, int32_t length, const std::shared_ptr< MemoryPool > &pool)</div><div class="ttdoc">Deserializes a single commit message from binary data.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a3658330e724ddae3ac54be4715907e8f"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a3658330e724ddae3ac54be4715907e8f">paimon::CommitMessage::SerializeList</a></div><div class="ttdeci">static Result< std::string > SerializeList(const std::vector< std::shared_ptr< CommitMessage > > &commit_messages, const std::shared_ptr< MemoryPool > &pool)</div><div class="ttdoc">Serializes a list of commit messages to a binary string format.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a452a4d820731446cd0040ae984dfd0e4"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a452a4d820731446cd0040ae984dfd0e4">paimon::CommitMessage::DeserializeList</a></div><div class="ttdeci">static Result< std::vector< std::shared_ptr< CommitMessage > > > DeserializeList(int32_t version, const char *buffer, int32_t length, const std::shared_ptr< MemoryPool > &pool)</div><div class="ttdoc">Deserializes a list of commit messages from binary data.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a632e176063fab576732c6241c6bd6856"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a632e176063fab576732c6241c6bd6856">paimon::CommitMessage::~CommitMessage</a></div><div class="ttdeci">virtual ~CommitMessage()</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_a9159f8ad92ea44772c23c79520314604"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#a9159f8ad92ea44772c23c79520314604">paimon::CommitMessage::CurrentVersion</a></div><div class="ttdeci">static int32_t CurrentVersion()</div><div class="ttdoc">Gets the version with which this serializer serializes.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_commit_message_html_aef2ceb513f93eb8ff64b67626bd8ce89"><div class="ttname"><a href="classpaimon_1_1_commit_message.html#aef2ceb513f93eb8ff64b67626bd8ce89">paimon::CommitMessage::Serialize</a></div><div class="ttdeci">static Result< std::string > Serialize(const std::shared_ptr< CommitMessage > &commit_message, const std::shared_ptr< MemoryPool > &pool)</div><div class="ttdoc">Serializes a single commit message to a binary string format.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_result_html"><div class="ttname"><a href="classpaimon_1_1_result.html">paimon::Result</a></div><div class="ttdoc">A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...</div><div class="ttdef"><b>Definition</b> result.h:33</div></div> |
| <div class="ttc" id="anamespacepaimon_html"><div class="ttname"><a href="namespacepaimon.html">paimon</a></div><div class="ttdoc">Top-level namespace for Paimon C++ API.</div><div class="ttdef"><b>Definition</b> api.h:42</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></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 class="ttc" id="avisibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.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> |
