| <!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: paimon::CommitMessage 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">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> |
| <!-- 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="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</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="classpaimon_1_1_commit_message-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::CommitMessage Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Commit message for partition and bucket. |
| <a href="classpaimon_1_1_commit_message.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="commit__message_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/commit_message.h</a>></code></p> |
| <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:a632e176063fab576732c6241c6bd6856" id="r_a632e176063fab576732c6241c6bd6856"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a632e176063fab576732c6241c6bd6856">~CommitMessage</a> ()</td></tr> |
| <tr class="separator:a632e176063fab576732c6241c6bd6856"><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:a9159f8ad92ea44772c23c79520314604" id="r_a9159f8ad92ea44772c23c79520314604"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a9159f8ad92ea44772c23c79520314604">CurrentVersion</a> ()</td></tr> |
| <tr class="memdesc:a9159f8ad92ea44772c23c79520314604"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version with which this serializer serializes. <br /></td></tr> |
| <tr class="separator:a9159f8ad92ea44772c23c79520314604"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef2ceb513f93eb8ff64b67626bd8ce89" id="r_aef2ceb513f93eb8ff64b67626bd8ce89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#aef2ceb513f93eb8ff64b67626bd8ce89">Serialize</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">commit_message</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:aef2ceb513f93eb8ff64b67626bd8ce89"><td class="mdescLeft"> </td><td class="mdescRight">Serializes a single commit message to a binary string format. <br /></td></tr> |
| <tr class="separator:aef2ceb513f93eb8ff64b67626bd8ce89"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3658330e724ddae3ac54be4715907e8f" id="r_a3658330e724ddae3ac54be4715907e8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a3658330e724ddae3ac54be4715907e8f">SerializeList</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">commit_messages</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:a3658330e724ddae3ac54be4715907e8f"><td class="mdescLeft"> </td><td class="mdescRight">Serializes a list of commit messages to a binary string format. <br /></td></tr> |
| <tr class="separator:a3658330e724ddae3ac54be4715907e8f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a13c70379bb2ce34af537b85a5f4b7270" id="r_a13c70379bb2ce34af537b85a5f4b7270"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a13c70379bb2ce34af537b85a5f4b7270">Deserialize</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">version</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> *buffer, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> length, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:a13c70379bb2ce34af537b85a5f4b7270"><td class="mdescLeft"> </td><td class="mdescRight">Deserializes a single commit message from binary data. <br /></td></tr> |
| <tr class="separator:a13c70379bb2ce34af537b85a5f4b7270"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a452a4d820731446cd0040ae984dfd0e4" id="r_a452a4d820731446cd0040ae984dfd0e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::vector< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a452a4d820731446cd0040ae984dfd0e4">DeserializeList</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">version</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> *buffer, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> length, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:a452a4d820731446cd0040ae984dfd0e4"><td class="mdescLeft"> </td><td class="mdescRight">Deserializes a list of commit messages from binary data. <br /></td></tr> |
| <tr class="separator:a452a4d820731446cd0040ae984dfd0e4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a03619d672e0ddc55d55b3da2b7e42d5a" id="r_a03619d672e0ddc55d55b3da2b7e42d5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_commit_message.html#a03619d672e0ddc55d55b3da2b7e42d5a">ToDebugString</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">commit_message</a>)</td></tr> |
| <tr class="memdesc:a03619d672e0ddc55d55b3da2b7e42d5a"><td class="mdescLeft"> </td><td class="mdescRight">Converts a commit message to a human-readable debug string. <br /></td></tr> |
| <tr class="separator:a03619d672e0ddc55d55b3da2b7e42d5a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Commit message for partition and bucket. </p> |
| <p>Supports serialization and deserialization compatible with the Java version.</p> |
| <dl class="section note"><dt>Note</dt><dd>Serialized payloads do not embed their serialization version. Transport <code><a class="el" href="classpaimon_1_1_commit_message.html#a9159f8ad92ea44772c23c79520314604" title="Gets the version with which this serializer serializes.">CurrentVersion()</a></code> alongside the payload and pass it explicitly to <code><a class="el" href="classpaimon_1_1_commit_message.html#a13c70379bb2ce34af537b85a5f4b7270" title="Deserializes a single commit message from binary data.">Deserialize()</a></code> or <code><a class="el" href="classpaimon_1_1_commit_message.html#a452a4d820731446cd0040ae984dfd0e4" title="Deserializes a list of commit messages from binary data.">DeserializeList()</a></code>. </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a632e176063fab576732c6241c6bd6856" name="a632e176063fab576732c6241c6bd6856"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a632e176063fab576732c6241c6bd6856">◆ </a></span>~CommitMessage()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> paimon::CommitMessage::~CommitMessage </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a9159f8ad92ea44772c23c79520314604" name="a9159f8ad92ea44772c23c79520314604"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9159f8ad92ea44772c23c79520314604">◆ </a></span>CurrentVersion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> paimon::CommitMessage::CurrentVersion </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the version with which this serializer serializes. </p> |
| |
| </div> |
| </div> |
| <a id="aef2ceb513f93eb8ff64b67626bd8ce89" name="aef2ceb513f93eb8ff64b67626bd8ce89"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef2ceb513f93eb8ff64b67626bd8ce89">◆ </a></span>Serialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > paimon::CommitMessage::Serialize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > & </td> |
| <td class="paramname"><em>commit_message</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serializes a single commit message to a binary string format. </p> |
| <p>The serialized format is compatible with the Java version of Paimon. The serialization version is not included in the returned payload. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commit_message</td><td>The commit message to serialize. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for memory allocation during serialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the serialized string data, or an error if serialization fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3658330e724ddae3ac54be4715907e8f" name="a3658330e724ddae3ac54be4715907e8f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3658330e724ddae3ac54be4715907e8f">◆ </a></span>SerializeList()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > paimon::CommitMessage::SerializeList </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::vector< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > & </td> |
| <td class="paramname"><em>commit_messages</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serializes a list of commit messages to a binary string format. </p> |
| <p>The serialization version is not included in the returned payload. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commit_messages</td><td>Vector of commit messages to serialize. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for memory allocation during serialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the serialized string data, or an error if serialization fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a13c70379bb2ce34af537b85a5f4b7270" name="a13c70379bb2ce34af537b85a5f4b7270"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a13c70379bb2ce34af537b85a5f4b7270">◆ </a></span>Deserialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > paimon::CommitMessage::Deserialize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>version</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> * </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Deserializes a single commit message from binary data. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">version</td><td>The serialization format version used when the data was serialized. </td></tr> |
| <tr><td class="paramname">buffer</td><td>Pointer to the binary data buffer. </td></tr> |
| <tr><td class="paramname">length</td><td>Length of the binary data in bytes. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for memory allocation during deserialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the deserialized <a class="el" href="classpaimon_1_1_commit_message.html" title="Commit message for partition and bucket.">CommitMessage</a>, or an error if deserialization fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a452a4d820731446cd0040ae984dfd0e4" name="a452a4d820731446cd0040ae984dfd0e4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a452a4d820731446cd0040ae984dfd0e4">◆ </a></span>DeserializeList()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::vector< std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > > > paimon::CommitMessage::DeserializeList </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>version</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> * </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Deserializes a list of commit messages from binary data. </p> |
| <p>This is the counterpart to <a class="el" href="classpaimon_1_1_commit_message.html#a3658330e724ddae3ac54be4715907e8f" title="Serializes a list of commit messages to a binary string format.">SerializeList()</a> for batch processing. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">version</td><td>The serialization format version used when the data was serialized. </td></tr> |
| <tr><td class="paramname">buffer</td><td>Pointer to the binary data buffer. </td></tr> |
| <tr><td class="paramname">length</td><td>Length of the binary data in bytes. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for memory allocation during deserialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing a vector of deserialized CommitMessages, or an error if deserialization fails. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a03619d672e0ddc55d55b3da2b7e42d5a" name="a03619d672e0ddc55d55b3da2b7e42d5a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a03619d672e0ddc55d55b3da2b7e42d5a">◆ </a></span>ToDebugString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > paimon::CommitMessage::ToDebugString </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_commit_message.html">CommitMessage</a> > & </td> |
| <td class="paramname"><em>commit_message</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Converts a commit message to a human-readable debug string. </p> |
| <p>This is useful for logging, debugging, and troubleshooting purposes. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">commit_message</td><td>The commit message to convert to string. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the debug string representation, or an error if conversion fails. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/<a class="el" href="commit__message_8h_source.html">commit_message.h</a></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> |
