| <!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::StdFileIO 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"><b>test</b></li><li class="navelem"><a class="el" href="classiceberg_1_1test_1_1StdFileIO.html">StdFileIO</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1test_1_1StdFileIO-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::test::StdFileIO Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Simple local filesystem <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation for testing. |
| <a href="classiceberg_1_1test_1_1StdFileIO.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="std__io_8h_source.html">std_io.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::test::StdFileIO:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1test_1_1StdFileIO.png" usemap="#iceberg::test::StdFileIO_map" alt=""/> |
| <map id="iceberg::test::StdFileIO_map" name="iceberg::test::StdFileIO_map"> |
| <area href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files." alt="iceberg::FileIO" shape="rect" coords="0,0,138,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:a05aaa2438f805520e76fa54aa6f2d8a2" id="r_a05aaa2438f805520e76fa54aa6f2d8a2"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdFileIO.html#a05aaa2438f805520e76fa54aa6f2d8a2">NewInputFile</a> (std::string file_location) override</td></tr> |
| <tr class="memdesc:a05aaa2438f805520e76fa54aa6f2d8a2"><td class="mdescLeft"> </td><td class="mdescRight">Create an input file handle for the given location. <br /></td></tr> |
| <tr class="separator:a05aaa2438f805520e76fa54aa6f2d8a2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7978fa3867d0ce231b735341748f3a28" id="r_a7978fa3867d0ce231b735341748f3a28"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdFileIO.html#a7978fa3867d0ce231b735341748f3a28">NewInputFile</a> (std::string file_location, size_t length) override</td></tr> |
| <tr class="memdesc:a7978fa3867d0ce231b735341748f3a28"><td class="mdescLeft"> </td><td class="mdescRight">Create an input file handle for the given location with a known length. <br /></td></tr> |
| <tr class="separator:a7978fa3867d0ce231b735341748f3a28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5629cdd8ea1c2a5260b144707f64c0b0" id="r_a5629cdd8ea1c2a5260b144707f64c0b0"><td class="memItemLeft" align="right" valign="top">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1OutputFile.html">OutputFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdFileIO.html#a5629cdd8ea1c2a5260b144707f64c0b0">NewOutputFile</a> (std::string file_location) override</td></tr> |
| <tr class="memdesc:a5629cdd8ea1c2a5260b144707f64c0b0"><td class="mdescLeft"> </td><td class="mdescRight">Create an output file handle for the given location. <br /></td></tr> |
| <tr class="separator:a5629cdd8ea1c2a5260b144707f64c0b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1050c568739393ef643f8601086a354e" id="r_a1050c568739393ef643f8601086a354e"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1test_1_1StdFileIO.html#a1050c568739393ef643f8601086a354e">DeleteFile</a> (const std::string &file_location) override</td></tr> |
| <tr class="memdesc:a1050c568739393ef643f8601086a354e"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file at the given location. <br /></td></tr> |
| <tr class="separator:a1050c568739393ef643f8601086a354e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classiceberg_1_1FileIO"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1FileIO')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1FileIO.html">iceberg::FileIO</a></td></tr> |
| <tr class="memitem:a110b0f784b0e25f51a72ac925799543c inherit pub_methods_classiceberg_1_1FileIO" id="r_a110b0f784b0e25f51a72ac925799543c"><td class="memItemLeft" align="right" valign="top">virtual Result< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a110b0f784b0e25f51a72ac925799543c">ReadFile</a> (const std::string &file_location, std::optional< size_t > length)</td></tr> |
| <tr class="memdesc:a110b0f784b0e25f51a72ac925799543c inherit pub_methods_classiceberg_1_1FileIO"><td class="mdescLeft"> </td><td class="mdescRight">Read the content of the file at the given location. <br /></td></tr> |
| <tr class="separator:a110b0f784b0e25f51a72ac925799543c inherit pub_methods_classiceberg_1_1FileIO"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c4d440121e666052c1f55194209c375 inherit pub_methods_classiceberg_1_1FileIO" id="r_a4c4d440121e666052c1f55194209c375"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a4c4d440121e666052c1f55194209c375">WriteFile</a> (const std::string &file_location, std::string_view content)</td></tr> |
| <tr class="memdesc:a4c4d440121e666052c1f55194209c375 inherit pub_methods_classiceberg_1_1FileIO"><td class="mdescLeft"> </td><td class="mdescRight">Write the given content to the file at the given location. <br /></td></tr> |
| <tr class="separator:a4c4d440121e666052c1f55194209c375 inherit pub_methods_classiceberg_1_1FileIO"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Simple local filesystem <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation for testing. </p> |
| <p>This class provides a basic <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a> implementation that reads and writes files to the local filesystem using standard C++ file streams. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a1050c568739393ef643f8601086a354e" name="a1050c568739393ef643f8601086a354e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1050c568739393ef643f8601086a354e">◆ </a></span>DeleteFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Status iceberg::test::StdFileIO::DeleteFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file_location</em></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>Delete a file at the given location. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_location</td><td>The location of the file to delete. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>void if the delete succeeded, an error code if the delete failed. </dd></dl> |
| |
| <p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937">iceberg::FileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a05aaa2438f805520e76fa54aa6f2d8a2" name="a05aaa2438f805520e76fa54aa6f2d8a2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a05aaa2438f805520e76fa54aa6f2d8a2">◆ </a></span>NewInputFile() <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">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > iceberg::test::StdFileIO::NewInputFile </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>file_location</em></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>Create an input file handle for the given location. </p> |
| |
| <p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#a7382a497499449305bbc7ac710b4518e">iceberg::FileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7978fa3867d0ce231b735341748f3a28" name="a7978fa3867d0ce231b735341748f3a28"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7978fa3867d0ce231b735341748f3a28">◆ </a></span>NewInputFile() <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">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > iceberg::test::StdFileIO::NewInputFile </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>file_location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>length</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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an input file handle for the given location with a known length. </p> |
| <p>The length is a caller-provided content length hint. Implementations may use it to avoid an extra metadata lookup. </p> |
| |
| <p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#ac3de646d00ec6e4be1f7a6e7513fe4a9">iceberg::FileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5629cdd8ea1c2a5260b144707f64c0b0" name="a5629cdd8ea1c2a5260b144707f64c0b0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5629cdd8ea1c2a5260b144707f64c0b0">◆ </a></span>NewOutputFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::unique_ptr< <a class="el" href="classiceberg_1_1OutputFile.html">OutputFile</a> > > iceberg::test::StdFileIO::NewOutputFile </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>file_location</em></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>Create an output file handle for the given location. </p> |
| |
| <p>Reimplemented from <a class="el" href="classiceberg_1_1FileIO.html#a0c817d2a00f3ab2bccfd6ece3827ddee">iceberg::FileIO</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 <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> |
