Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1test_1_1StdInputFile.html
blob: 0efb27ef223e5458ed0e88e24622f61c6d42c652 [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>iceberg-cpp: iceberg::test::StdInputFile 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">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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"><b>iceberg</b></li><li class="navelem"><b>test</b></li><li class="navelem"><a class="el" href="classiceberg_1_1test_1_1StdInputFile.html">StdInputFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1test_1_1StdInputFile-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::test::StdInputFile Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for iceberg::test::StdInputFile:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1test_1_1StdInputFile.png" usemap="#iceberg::test::StdInputFile_map" alt=""/>
<map id="iceberg::test::StdInputFile_map" name="iceberg::test::StdInputFile_map">
<area href="classiceberg_1_1InputFile.html" title="Handle for opening a readable file." alt="iceberg::InputFile" shape="rect" coords="0,0,152,24"/>
</map>
</div></div>
<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:a23e674a3cb9d36166cb04b7d3a6989cb" id="r_a23e674a3cb9d36166cb04b7d3a6989cb"><td class="memItemLeft" align="right" valign="top"><a id="a23e674a3cb9d36166cb04b7d3a6989cb" name="a23e674a3cb9d36166cb04b7d3a6989cb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StdInputFile</b> (std::string <a class="el" href="classiceberg_1_1test_1_1StdInputFile.html#a38ad27dacd93d24da917194038724248">location</a>, std::optional&lt; int64_t &gt; file_size=std::nullopt)</td></tr>
<tr class="separator:a23e674a3cb9d36166cb04b7d3a6989cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38ad27dacd93d24da917194038724248" id="r_a38ad27dacd93d24da917194038724248"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdInputFile.html#a38ad27dacd93d24da917194038724248">location</a> () const override</td></tr>
<tr class="memdesc:a38ad27dacd93d24da917194038724248"><td class="mdescLeft">&#160;</td><td class="mdescRight">File location represented by this handle. <br /></td></tr>
<tr class="separator:a38ad27dacd93d24da917194038724248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28ba4a6b356600ed1188c0d77714ba80" id="r_a28ba4a6b356600ed1188c0d77714ba80"><td class="memItemLeft" align="right" valign="top">Result&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdInputFile.html#a28ba4a6b356600ed1188c0d77714ba80">Size</a> () const override</td></tr>
<tr class="memdesc:a28ba4a6b356600ed1188c0d77714ba80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the total file size in bytes. <br /></td></tr>
<tr class="separator:a28ba4a6b356600ed1188c0d77714ba80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3baf79aa43151e01d9a66f3dced2494" id="r_af3baf79aa43151e01d9a66f3dced2494"><td class="memItemLeft" align="right" valign="top">Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1SeekableInputStream.html">SeekableInputStream</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdInputFile.html#af3baf79aa43151e01d9a66f3dced2494">Open</a> () override</td></tr>
<tr class="memdesc:af3baf79aa43151e01d9a66f3dced2494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a new independent input stream. <br /></td></tr>
<tr class="separator:af3baf79aa43151e01d9a66f3dced2494"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a38ad27dacd93d24da917194038724248" name="a38ad27dacd93d24da917194038724248"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38ad27dacd93d24da917194038724248">&#9670;&#160;</a></span>location()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view iceberg::test::StdInputFile::location </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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>File location represented by this handle. </p>
<p>Implements <a class="el" href="classiceberg_1_1InputFile.html#a187e1519accc6da35fdafc779551c303">iceberg::InputFile</a>.</p>
</div>
</div>
<a id="af3baf79aa43151e01d9a66f3dced2494" name="af3baf79aa43151e01d9a66f3dced2494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3baf79aa43151e01d9a66f3dced2494">&#9670;&#160;</a></span>Open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1SeekableInputStream.html">SeekableInputStream</a> &gt; &gt; iceberg::test::StdInputFile::Open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a new independent input stream. </p>
<p>Implements <a class="el" href="classiceberg_1_1InputFile.html#a6fe70deb243671584f2b02ab473c74f9">iceberg::InputFile</a>.</p>
</div>
</div>
<a id="a28ba4a6b356600ed1188c0d77714ba80" name="a28ba4a6b356600ed1188c0d77714ba80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28ba4a6b356600ed1188c0d77714ba80">&#9670;&#160;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; int64_t &gt; iceberg::test::StdInputFile::Size </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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the total file size in bytes. </p>
<p>Implements <a class="el" href="classiceberg_1_1InputFile.html#a8c4986b0d2b414dc2791cb528f035837">iceberg::InputFile</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/test/<a class="el" href="std__io_8h_source.html">std_io.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>