| <!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::SeekableInputStream 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&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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1SeekableInputStream.html">SeekableInputStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1SeekableInputStream-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::SeekableInputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Seekable byte stream for reading file contents. |
| <a href="classiceberg_1_1SeekableInputStream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="file__io_8h_source.html">file_io.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::SeekableInputStream:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1SeekableInputStream.png" usemap="#iceberg::SeekableInputStream_map" alt=""/> |
| <map id="iceberg::SeekableInputStream_map" name="iceberg::SeekableInputStream_map"> |
| <area href="classiceberg_1_1test_1_1StdSeekableInputStream.html" alt="iceberg::test::StdSeekableInputStream" shape="rect" coords="0,56,222,80"/> |
| </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:a15f4cc3bf14906e53ed6c4cb15db8d60" id="r_a15f4cc3bf14906e53ed6c4cb15db8d60"><td class="memItemLeft" align="right" valign="top">virtual Result< int64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SeekableInputStream.html#a15f4cc3bf14906e53ed6c4cb15db8d60">Position</a> () const =0</td></tr> |
| <tr class="memdesc:a15f4cc3bf14906e53ed6c4cb15db8d60"><td class="mdescLeft"> </td><td class="mdescRight">Return the current read position. <br /></td></tr> |
| <tr class="separator:a15f4cc3bf14906e53ed6c4cb15db8d60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeadf82ee6dfd2d55ede7fe5455a8b840" id="r_aeadf82ee6dfd2d55ede7fe5455a8b840"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SeekableInputStream.html#aeadf82ee6dfd2d55ede7fe5455a8b840">Seek</a> (int64_t position)=0</td></tr> |
| <tr class="memdesc:aeadf82ee6dfd2d55ede7fe5455a8b840"><td class="mdescLeft"> </td><td class="mdescRight">Seek to an absolute byte position. <br /></td></tr> |
| <tr class="separator:aeadf82ee6dfd2d55ede7fe5455a8b840"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a596aa5878a505860a303d62bae01fc30" id="r_a596aa5878a505860a303d62bae01fc30"><td class="memItemLeft" align="right" valign="top">virtual Result< int64_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SeekableInputStream.html#a596aa5878a505860a303d62bae01fc30">Read</a> (std::span< std::byte > out)=0</td></tr> |
| <tr class="memdesc:a596aa5878a505860a303d62bae01fc30"><td class="mdescLeft"> </td><td class="mdescRight">Read up to out.size() bytes from the current position. <br /></td></tr> |
| <tr class="separator:a596aa5878a505860a303d62bae01fc30"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbe1a1b7cbdae7b20bd47aa0beb2b0e0" id="r_afbe1a1b7cbdae7b20bd47aa0beb2b0e0"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SeekableInputStream.html#afbe1a1b7cbdae7b20bd47aa0beb2b0e0">ReadFully</a> (int64_t position, std::span< std::byte > out)=0</td></tr> |
| <tr class="memdesc:afbe1a1b7cbdae7b20bd47aa0beb2b0e0"><td class="mdescLeft"> </td><td class="mdescRight">Read exactly out.size() bytes from an absolute position. <br /></td></tr> |
| <tr class="separator:afbe1a1b7cbdae7b20bd47aa0beb2b0e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef1ea679d2801b518a527390c07065ae" id="r_aef1ea679d2801b518a527390c07065ae"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1SeekableInputStream.html#aef1ea679d2801b518a527390c07065ae">Close</a> ()=0</td></tr> |
| <tr class="memdesc:aef1ea679d2801b518a527390c07065ae"><td class="mdescLeft"> </td><td class="mdescRight">Close the stream. Implementations should allow repeated Close calls. <br /></td></tr> |
| <tr class="separator:aef1ea679d2801b518a527390c07065ae"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Seekable byte stream for reading file contents. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aef1ea679d2801b518a527390c07065ae" name="aef1ea679d2801b518a527390c07065ae"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef1ea679d2801b518a527390c07065ae">◆ </a></span>Close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::SeekableInputStream::Close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the stream. Implementations should allow repeated Close calls. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1test_1_1StdSeekableInputStream.html#a2d9ffc37f8c10aadce37cbc9d74af476">iceberg::test::StdSeekableInputStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a15f4cc3bf14906e53ed6c4cb15db8d60" name="a15f4cc3bf14906e53ed6c4cb15db8d60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a15f4cc3bf14906e53ed6c4cb15db8d60">◆ </a></span>Position()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Result< int64_t > iceberg::SeekableInputStream::Position </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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the current read position. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1test_1_1StdSeekableInputStream.html#afda1a87c8c93ecf18cee6c1f5563940d">iceberg::test::StdSeekableInputStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a596aa5878a505860a303d62bae01fc30" name="a596aa5878a505860a303d62bae01fc30"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a596aa5878a505860a303d62bae01fc30">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Result< int64_t > iceberg::SeekableInputStream::Read </td> |
| <td>(</td> |
| <td class="paramtype">std::span< std::byte > </td> |
| <td class="paramname"><em>out</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read up to out.size() bytes from the current position. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1test_1_1StdSeekableInputStream.html#aa2f03b762c02bcbf068a1654f653775a">iceberg::test::StdSeekableInputStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="afbe1a1b7cbdae7b20bd47aa0beb2b0e0" name="afbe1a1b7cbdae7b20bd47aa0beb2b0e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbe1a1b7cbdae7b20bd47aa0beb2b0e0">◆ </a></span>ReadFully()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::SeekableInputStream::ReadFully </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>position</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::span< std::byte > </td> |
| <td class="paramname"><em>out</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">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read exactly out.size() bytes from an absolute position. </p> |
| <p>Fails if fewer than out.size() bytes are available. The current stream position after this call is unspecified; callers should Seek before subsequent position-dependent reads. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1test_1_1StdSeekableInputStream.html#ae197c5d531c16e0d063daf9d37f9e420">iceberg::test::StdSeekableInputStream</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aeadf82ee6dfd2d55ede7fe5455a8b840" name="aeadf82ee6dfd2d55ede7fe5455a8b840"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeadf82ee6dfd2d55ede7fe5455a8b840">◆ </a></span>Seek()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual Status iceberg::SeekableInputStream::Seek </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>position</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Seek to an absolute byte position. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1test_1_1StdSeekableInputStream.html#a41a2e25806e4f3222a1d54fc8d38ff75">iceberg::test::StdSeekableInputStream</a>.</p> |
| |
| </div> |
| </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 <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> |
