blob: fe5d6b38a0ae5e0470508417af335d29cef2e2ae [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::InputFile 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1InputFile.html">InputFile</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_1InputFile-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::InputFile Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Handle for opening a readable file.
<a href="classiceberg_1_1InputFile.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="file__io_8h_source.html">file_io.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:a187e1519accc6da35fdafc779551c303" id="r_a187e1519accc6da35fdafc779551c303"><td class="memItemLeft" align="right" valign="top"><a id="a187e1519accc6da35fdafc779551c303" name="a187e1519accc6da35fdafc779551c303"></a>
virtual std::string_view&#160;</td><td class="memItemRight" valign="bottom"><b>location</b> () const =0</td></tr>
<tr class="memdesc:a187e1519accc6da35fdafc779551c303"><td class="mdescLeft">&#160;</td><td class="mdescRight">File location represented by this handle. <br /></td></tr>
<tr class="separator:a187e1519accc6da35fdafc779551c303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c4986b0d2b414dc2791cb528f035837" id="r_a8c4986b0d2b414dc2791cb528f035837"><td class="memItemLeft" align="right" valign="top"><a id="a8c4986b0d2b414dc2791cb528f035837" name="a8c4986b0d2b414dc2791cb528f035837"></a>
virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; int64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Size</b> () const =0</td></tr>
<tr class="memdesc:a8c4986b0d2b414dc2791cb528f035837"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the total file size in bytes. <br /></td></tr>
<tr class="separator:a8c4986b0d2b414dc2791cb528f035837"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fe70deb243671584f2b02ab473c74f9" id="r_a6fe70deb243671584f2b02ab473c74f9"><td class="memItemLeft" align="right" valign="top"><a id="a6fe70deb243671584f2b02ab473c74f9" name="a6fe70deb243671584f2b02ab473c74f9"></a>
virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1SeekableInputStream.html">SeekableInputStream</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Open</b> ()=0</td></tr>
<tr class="memdesc:a6fe70deb243671584f2b02ab473c74f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a new independent input stream. <br /></td></tr>
<tr class="separator:a6fe70deb243671584f2b02ab473c74f9"><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>Handle for opening a readable file. </p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/<a class="el" href="file__io_8h_source.html">file_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>