| <!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::DataInputStream 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_data_input_stream.html">DataInputStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pri-methods">Private Member Functions</a> | |
| <a href="#pri-attribs">Private Attributes</a> | |
| <a href="classpaimon_1_1_data_input_stream-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::DataInputStream Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code><a class="el" href="classpaimon_1_1_data_input_stream.html" title="DataInputStream provides a convenient wrapper around InputStream for reading typed data.">DataInputStream</a></code> provides a convenient wrapper around <code><a class="el" href="classpaimon_1_1_input_stream.html" title="Abstract class for input stream operations.">InputStream</a></code> for reading typed data. |
| <a href="classpaimon_1_1_data_input_stream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="data__input__stream_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/io/data_input_stream.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:a2707cf4439bb0d8d14da34a7be98e508" id="r_a2707cf4439bb0d8d14da34a7be98e508"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a2707cf4439bb0d8d14da34a7be98e508">DataInputStream</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_input_stream.html">InputStream</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">input_stream</a>)</td></tr> |
| <tr class="memdesc:a2707cf4439bb0d8d14da34a7be98e508"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <code><a class="el" href="classpaimon_1_1_data_input_stream.html" title="DataInputStream provides a convenient wrapper around InputStream for reading typed data.">DataInputStream</a></code> wrapping the given <code><a class="el" href="classpaimon_1_1_input_stream.html" title="Abstract class for input stream operations.">InputStream</a></code>. <br /></td></tr> |
| <tr class="separator:a2707cf4439bb0d8d14da34a7be98e508"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8880ec11e07b93a631d503e2eba5d97" id="r_af8880ec11e07b93a631d503e2eba5d97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#af8880ec11e07b93a631d503e2eba5d97">Seek</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> offset) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:af8880ec11e07b93a631d503e2eba5d97"><td class="mdescLeft"> </td><td class="mdescRight">Seek to a specific position in the underlying input stream. <br /></td></tr> |
| <tr class="separator:af8880ec11e07b93a631d503e2eba5d97"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a382fb1c4d6d93add5fbe1a7b339188c0" id="r_a382fb1c4d6d93add5fbe1a7b339188c0"><td class="memTemplParams" colspan="2">template<<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> > </td></tr> |
| <tr class="memitem:a382fb1c4d6d93add5fbe1a7b339188c0"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a382fb1c4d6d93add5fbe1a7b339188c0">ReadValue</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a382fb1c4d6d93add5fbe1a7b339188c0"><td class="mdescLeft"> </td><td class="mdescRight">Read a typed value from the stream. <br /></td></tr> |
| <tr class="separator:a382fb1c4d6d93add5fbe1a7b339188c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7e706f144cfd57fba8779f8b39b15778" id="r_a7e706f144cfd57fba8779f8b39b15778"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a7e706f144cfd57fba8779f8b39b15778">ReadBytes</a> (<a class="el" href="classpaimon_1_1_bytes.html">Bytes</a> *<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bytes</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a7e706f144cfd57fba8779f8b39b15778"><td class="mdescLeft"> </td><td class="mdescRight">Read some bytes to a <code><a class="el" href="classpaimon_1_1_bytes.html" title="A memory-managed byte array class that provides efficient storage and manipulation of binary data.">Bytes</a></code> object from the stream. <br /></td></tr> |
| <tr class="separator:a7e706f144cfd57fba8779f8b39b15778"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc3f894f0347171568a16db33937d74e" id="r_acc3f894f0347171568a16db33937d74e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#acc3f894f0347171568a16db33937d74e">Read</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> *data, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint32_t</a> size) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:acc3f894f0347171568a16db33937d74e"><td class="mdescLeft"> </td><td class="mdescRight">Read raw data of specified size from the stream. <br /></td></tr> |
| <tr class="separator:acc3f894f0347171568a16db33937d74e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ded3fd2556526c3850eb44b69fcaebe" id="r_a7ded3fd2556526c3850eb44b69fcaebe"><td class="memItemLeft" align="right" valign="top"><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_data_input_stream.html#a7ded3fd2556526c3850eb44b69fcaebe">ReadString</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a7ded3fd2556526c3850eb44b69fcaebe"><td class="mdescLeft"> </td><td class="mdescRight">Read string from the stream. <br /></td></tr> |
| <tr class="separator:a7ded3fd2556526c3850eb44b69fcaebe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9053538fb581beae3578505bd96a407b" id="r_a9053538fb581beae3578505bd96a407b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a9053538fb581beae3578505bd96a407b">GetPos</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a9053538fb581beae3578505bd96a407b"><td class="mdescLeft"> </td><td class="mdescRight">Get the current position in the underlying input stream. <br /></td></tr> |
| <tr class="separator:a9053538fb581beae3578505bd96a407b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae60d58539219a175067ea60742eb216c" id="r_ae60d58539219a175067ea60742eb216c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#ae60d58539219a175067ea60742eb216c">Length</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:ae60d58539219a175067ea60742eb216c"><td class="mdescLeft"> </td><td class="mdescRight">Get the total length of the underlying input stream. <br /></td></tr> |
| <tr class="separator:ae60d58539219a175067ea60742eb216c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac3e6996300630f8853420fad310d8604" id="r_ac3e6996300630f8853420fad310d8604"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#ac3e6996300630f8853420fad310d8604">SetOrder</a> (<a class="el" href="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8">ByteOrder</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">order</a>)</td></tr> |
| <tr class="memdesc:ac3e6996300630f8853420fad310d8604"><td class="mdescLeft"> </td><td class="mdescRight">Set the byte order for endianness conversion. <br /></td></tr> |
| <tr class="separator:ac3e6996300630f8853420fad310d8604"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a> |
| Private Member Functions</h2></td></tr> |
| <tr class="memitem:a3e8ecef0f8153d4cda3381f7abcfae30" id="r_a3e8ecef0f8153d4cda3381f7abcfae30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a3e8ecef0f8153d4cda3381f7abcfae30">AssertReadLength</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">read_length</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">actual_read_length</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a3e8ecef0f8153d4cda3381f7abcfae30"><td class="mdescLeft"> </td><td class="mdescRight">Validate that the expected number of bytes were read. <br /></td></tr> |
| <tr class="separator:a3e8ecef0f8153d4cda3381f7abcfae30"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38bee69a116c8900eb646500ceda4135" id="r_a38bee69a116c8900eb646500ceda4135"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a38bee69a116c8900eb646500ceda4135">AssertBoundary</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">need_length</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a38bee69a116c8900eb646500ceda4135"><td class="mdescLeft"> </td><td class="mdescRight">Check if there are enough bytes available to read. <br /></td></tr> |
| <tr class="separator:a38bee69a116c8900eb646500ceda4135"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a43d6ba0316bd2a34db9777c412780125" id="r_a43d6ba0316bd2a34db9777c412780125"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a43d6ba0316bd2a34db9777c412780125">NeedSwap</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr> |
| <tr class="memdesc:a43d6ba0316bd2a34db9777c412780125"><td class="mdescLeft"> </td><td class="mdescRight">Determine if byte swapping is needed based on current byte order and system endianness. <br /></td></tr> |
| <tr class="separator:a43d6ba0316bd2a34db9777c412780125"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a> |
| Private Attributes</h2></td></tr> |
| <tr class="memitem:a385d07acfaae5dd188195a3c1864e41e" id="r_a385d07acfaae5dd188195a3c1864e41e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classpaimon_1_1_input_stream.html">InputStream</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a385d07acfaae5dd188195a3c1864e41e">input_stream_</a></td></tr> |
| <tr class="separator:a385d07acfaae5dd188195a3c1864e41e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4281b3b15730084352d831579eb3a0d9" id="r_a4281b3b15730084352d831579eb3a0d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8">ByteOrder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_input_stream.html#a4281b3b15730084352d831579eb3a0d9">byte_order_</a> = <a class="el" href="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8a566dd912653af0e0e1f6a49ee6a0e791">ByteOrder::PAIMON_BIG_ENDIAN</a></td></tr> |
| <tr class="separator:a4281b3b15730084352d831579eb3a0d9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><code><a class="el" href="classpaimon_1_1_data_input_stream.html" title="DataInputStream provides a convenient wrapper around InputStream for reading typed data.">DataInputStream</a></code> provides a convenient wrapper around <code><a class="el" href="classpaimon_1_1_input_stream.html" title="Abstract class for input stream operations.">InputStream</a></code> for reading typed data. </p> |
| <dl class="section note"><dt>Note</dt><dd>The default byte order is big-endian to maintain compatibility with the Java implementation. </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a2707cf4439bb0d8d14da34a7be98e508" name="a2707cf4439bb0d8d14da34a7be98e508"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2707cf4439bb0d8d14da34a7be98e508">◆ </a></span>DataInputStream()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">paimon::DataInputStream::DataInputStream </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_input_stream.html">InputStream</a> > & </td> |
| <td class="paramname"><em>input_stream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a <code><a class="el" href="classpaimon_1_1_data_input_stream.html" title="DataInputStream provides a convenient wrapper around InputStream for reading typed data.">DataInputStream</a></code> wrapping the given <code><a class="el" href="classpaimon_1_1_input_stream.html" title="Abstract class for input stream operations.">InputStream</a></code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">input_stream</td><td>The underlying input stream to read from. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="af8880ec11e07b93a631d503e2eba5d97" name="af8880ec11e07b93a631d503e2eba5d97"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8880ec11e07b93a631d503e2eba5d97">◆ </a></span>Seek()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_status.html">Status</a> paimon::DataInputStream::Seek </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> </td> |
| <td class="paramname"><em>offset</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Seek to a specific position in the underlying input stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">offset</td><td>The absolute byte offset to seek to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a382fb1c4d6d93add5fbe1a7b339188c0" name="a382fb1c4d6d93add5fbe1a7b339188c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a382fb1c4d6d93add5fbe1a7b339188c0">◆ </a></span>ReadValue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> > paimon::DataInputStream::ReadValue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read a typed value from the stream. </p> |
| <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 read value or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7e706f144cfd57fba8779f8b39b15778" name="a7e706f144cfd57fba8779f8b39b15778"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7e706f144cfd57fba8779f8b39b15778">◆ </a></span>ReadBytes()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_status.html">Status</a> paimon::DataInputStream::ReadBytes </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classpaimon_1_1_bytes.html">Bytes</a> * </td> |
| <td class="paramname"><em>bytes</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read some bytes to a <code><a class="el" href="classpaimon_1_1_bytes.html" title="A memory-managed byte array class that provides efficient storage and manipulation of binary data.">Bytes</a></code> object from the stream. </p> |
| <p>The length of bytes is the number of bytes read from the stream. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">bytes</td><td>Buffer to store the read bytes. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="acc3f894f0347171568a16db33937d74e" name="acc3f894f0347171568a16db33937d74e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acc3f894f0347171568a16db33937d74e">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_status.html">Status</a> paimon::DataInputStream::Read </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> * </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint32_t</a> </td> |
| <td class="paramname"><em>size</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read raw data of specified size from the stream. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>Buffer to store the read data. </td></tr> |
| <tr><td class="paramname">size</td><td>Number of bytes to read. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a7ded3fd2556526c3850eb44b69fcaebe" name="a7ded3fd2556526c3850eb44b69fcaebe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7ded3fd2556526c3850eb44b69fcaebe">◆ </a></span>ReadString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > paimon::DataInputStream::ReadString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read string from the stream. </p> |
| <dl class="section note"><dt>Note</dt><dd>First read length (int16), then read string bytes. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a9053538fb581beae3578505bd96a407b" name="a9053538fb581beae3578505bd96a407b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9053538fb581beae3578505bd96a407b">◆ </a></span>GetPos()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> > paimon::DataInputStream::GetPos </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the current position in the underlying input stream. </p> |
| |
| </div> |
| </div> |
| <a id="ae60d58539219a175067ea60742eb216c" name="ae60d58539219a175067ea60742eb216c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae60d58539219a175067ea60742eb216c">◆ </a></span>Length()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classpaimon_1_1_result.html">Result</a>< <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> > paimon::DataInputStream::Length </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the total length of the underlying input stream. </p> |
| |
| </div> |
| </div> |
| <a id="ac3e6996300630f8853420fad310d8604" name="ac3e6996300630f8853420fad310d8604"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac3e6996300630f8853420fad310d8604">◆ </a></span>SetOrder()</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">void</a> paimon::DataInputStream::SetOrder </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8">ByteOrder</a> </td> |
| <td class="paramname"><em>order</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the byte order for endianness conversion. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">order</td><td>The byte order to use <code>PAIMON_BIG_ENDIAN</code> or <code>PAIMON_LITTLE_ENDIAN</code>. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3e8ecef0f8153d4cda3381f7abcfae30" name="a3e8ecef0f8153d4cda3381f7abcfae30"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e8ecef0f8153d4cda3381f7abcfae30">◆ </a></span>AssertReadLength()</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="classpaimon_1_1_status.html">Status</a> paimon::DataInputStream::AssertReadLength </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>read_length</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>actual_read_length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Validate that the expected number of bytes were read. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">read_length</td><td>Expected number of bytes to read. </td></tr> |
| <tr><td class="paramname">actual_read_length</td><td>Actual number of bytes read. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a38bee69a116c8900eb646500ceda4135" name="a38bee69a116c8900eb646500ceda4135"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38bee69a116c8900eb646500ceda4135">◆ </a></span>AssertBoundary()</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="classpaimon_1_1_status.html">Status</a> paimon::DataInputStream::AssertBoundary </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> </td> |
| <td class="paramname"><em>need_length</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if there are enough bytes available to read. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">need_length</td><td>Number of bytes needed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a43d6ba0316bd2a34db9777c412780125" name="a43d6ba0316bd2a34db9777c412780125"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a43d6ba0316bd2a34db9777c412780125">◆ </a></span>NeedSwap()</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">bool</a> paimon::DataInputStream::NeedSwap </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Determine if byte swapping is needed based on current byte order and system endianness. </p> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if byte swapping is required, <code>false</code> otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a385d07acfaae5dd188195a3c1864e41e" name="a385d07acfaae5dd188195a3c1864e41e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a385d07acfaae5dd188195a3c1864e41e">◆ </a></span>input_stream_</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::shared_ptr<<a class="el" href="classpaimon_1_1_input_stream.html">InputStream</a>> paimon::DataInputStream::input_stream_</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a4281b3b15730084352d831579eb3a0d9" name="a4281b3b15730084352d831579eb3a0d9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4281b3b15730084352d831579eb3a0d9">◆ </a></span>byte_order_</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="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8">ByteOrder</a> paimon::DataInputStream::byte_order_ = <a class="el" href="namespacepaimon.html#ad9aa7d30bb0d191711934a49db8fece8a566dd912653af0e0e1f6a49ee6a0e791">ByteOrder::PAIMON_BIG_ENDIAN</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">private</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </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/io/<a class="el" href="data__input__stream_8h_source.html">data_input_stream.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> |
