Google Git
Sign in
apache/paimon-cpp/refs/heads/gh-pages/./apidoc/html/structpaimon_1_1_byte_range.html
blob: e08f59071cb3a595c6df62df3379bd66caf8135a [file]
<!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::ByteRange Struct 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&amp;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&amp;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="structpaimon_1_1_byte_range.html">ByteRange</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structpaimon_1_1_byte_range-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::ByteRange Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A byte range with offset and length.
<a href="structpaimon_1_1_byte_range.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="read__ahead__cache_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/utils/read_ahead_cache.h</a>&gt;</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:a22a86dd1f1f014cd1da639bdfd617771" id="r_a22a86dd1f1f014cd1da639bdfd617771"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_byte_range.html#a22a86dd1f1f014cd1da639bdfd617771">ByteRange</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr>
<tr class="separator:a22a86dd1f1f014cd1da639bdfd617771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26c73bede7e3e89201437bdeae87a52b" id="r_a26c73bede7e3e89201437bdeae87a52b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_byte_range.html#a26c73bede7e3e89201437bdeae87a52b">ByteRange</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> <a class="el" href="structpaimon_1_1_byte_range.html#a1db3d4bb8fb524a548eac031bf41b307">offset</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> <a class="el" href="structpaimon_1_1_byte_range.html#af6819a7e5e5a11f34f9197e5c4802108">length</a>)</td></tr>
<tr class="separator:a26c73bede7e3e89201437bdeae87a52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5ff13951209f168638e7faa305bb60c" id="r_aa5ff13951209f168638e7faa305bb60c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_byte_range.html#aa5ff13951209f168638e7faa305bb60c">Contains</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="structpaimon_1_1_byte_range.html">ByteRange</a> &amp;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">other</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr>
<tr class="separator:aa5ff13951209f168638e7faa305bb60c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1db3d4bb8fb524a548eac031bf41b307" id="r_a1db3d4bb8fb524a548eac031bf41b307"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_byte_range.html#a1db3d4bb8fb524a548eac031bf41b307">offset</a></td></tr>
<tr class="separator:a1db3d4bb8fb524a548eac031bf41b307"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6819a7e5e5a11f34f9197e5c4802108" id="r_af6819a7e5e5a11f34f9197e5c4802108"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_byte_range.html#af6819a7e5e5a11f34f9197e5c4802108">length</a></td></tr>
<tr class="separator:af6819a7e5e5a11f34f9197e5c4802108"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A byte range with offset and length. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a22a86dd1f1f014cd1da639bdfd617771" name="a22a86dd1f1f014cd1da639bdfd617771"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22a86dd1f1f014cd1da639bdfd617771">&#9670;&#160;</a></span>ByteRange() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">paimon::ByteRange::ByteRange </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a26c73bede7e3e89201437bdeae87a52b" name="a26c73bede7e3e89201437bdeae87a52b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26c73bede7e3e89201437bdeae87a52b">&#9670;&#160;</a></span>ByteRange() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">paimon::ByteRange::ByteRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a>&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a>&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa5ff13951209f168638e7faa305bb60c" name="aa5ff13951209f168638e7faa305bb60c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5ff13951209f168638e7faa305bb60c">&#9670;&#160;</a></span>Contains()</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::ByteRange::Contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="structpaimon_1_1_byte_range.html">ByteRange</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The other byte range to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this range contains the other range </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a1db3d4bb8fb524a548eac031bf41b307" name="a1db3d4bb8fb524a548eac031bf41b307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1db3d4bb8fb524a548eac031bf41b307">&#9670;&#160;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> paimon::ByteRange::offset</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af6819a7e5e5a11f34f9197e5c4802108" name="af6819a7e5e5a11f34f9197e5c4802108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6819a7e5e5a11f34f9197e5c4802108">&#9670;&#160;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">uint64_t</a> paimon::ByteRange::length</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/utils/<a class="el" href="read__ahead__cache_8h_source.html">read_ahead_cache.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>