| <!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::FileIO 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1FileIO.html">FileIO</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1FileIO-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::FileIO Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Pluggable module for reading, writing, and deleting files. |
| <a href="classiceberg_1_1FileIO.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::FileIO:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1FileIO.png" usemap="#iceberg::FileIO_map" alt=""/> |
| <map id="iceberg::FileIO_map" name="iceberg::FileIO_map"> |
| <area href="classiceberg_1_1ResolvingFileIO.html" title="FileIO that resolves and caches implementations by registry name." alt="iceberg::ResolvingFileIO" shape="rect" coords="0,56,150,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:a69825dcdb4b389ad96bfc0cb66047f04" id="r_a69825dcdb4b389ad96bfc0cb66047f04"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< 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_1FileIO.html#a69825dcdb4b389ad96bfc0cb66047f04">NewInputFile</a> (std::string file_location)</td></tr> |
| <tr class="memdesc:a69825dcdb4b389ad96bfc0cb66047f04"><td class="mdescLeft"> </td><td class="mdescRight">Create an input file handle for the given location. <br /></td></tr> |
| <tr class="separator:a69825dcdb4b389ad96bfc0cb66047f04"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a033abce013bf469c31bfeb014a80f729" id="r_a033abce013bf469c31bfeb014a80f729"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< 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_1FileIO.html#a033abce013bf469c31bfeb014a80f729">NewInputFile</a> (std::string file_location, size_t length)</td></tr> |
| <tr class="memdesc:a033abce013bf469c31bfeb014a80f729"><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:a033abce013bf469c31bfeb014a80f729"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0d9bbfec5421979aa3c6949dcbb03e9d" id="r_a0d9bbfec5421979aa3c6949dcbb03e9d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< 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_1FileIO.html#a0d9bbfec5421979aa3c6949dcbb03e9d">NewOutputFile</a> (std::string file_location)</td></tr> |
| <tr class="memdesc:a0d9bbfec5421979aa3c6949dcbb03e9d"><td class="mdescLeft"> </td><td class="mdescRight">Create an output file handle for the given location. <br /></td></tr> |
| <tr class="separator:a0d9bbfec5421979aa3c6949dcbb03e9d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a714e3babeac9395ed6ef4b2f5c94a5cd" id="r_a714e3babeac9395ed6ef4b2f5c94a5cd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a714e3babeac9395ed6ef4b2f5c94a5cd">ReadFile</a> (const std::string &file_location, std::optional< size_t > length)</td></tr> |
| <tr class="memdesc:a714e3babeac9395ed6ef4b2f5c94a5cd"><td class="mdescLeft"> </td><td class="mdescRight">Read the content of the file at the given location. <br /></td></tr> |
| <tr class="separator:a714e3babeac9395ed6ef4b2f5c94a5cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a527a78aca1045034250f50a51d8dc0f9" id="r_a527a78aca1045034250f50a51d8dc0f9"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a527a78aca1045034250f50a51d8dc0f9">WriteFile</a> (const std::string &file_location, std::string_view content)</td></tr> |
| <tr class="memdesc:a527a78aca1045034250f50a51d8dc0f9"><td class="mdescLeft"> </td><td class="mdescRight">Write the given content to the file at the given location. <br /></td></tr> |
| <tr class="separator:a527a78aca1045034250f50a51d8dc0f9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace7c9ec329017d5a99082739e8578937" id="r_ace7c9ec329017d5a99082739e8578937"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937">DeleteFile</a> (const std::string &file_location)</td></tr> |
| <tr class="memdesc:ace7c9ec329017d5a99082739e8578937"><td class="mdescLeft"> </td><td class="mdescRight">Delete a file at the given location. <br /></td></tr> |
| <tr class="separator:ace7c9ec329017d5a99082739e8578937"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8f90138ef899b636494eee5f49243040" id="r_a8f90138ef899b636494eee5f49243040"><td class="memItemLeft" align="right" valign="top">virtual Status </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a8f90138ef899b636494eee5f49243040">DeleteFiles</a> (const std::vector< std::string > &file_locations)</td></tr> |
| <tr class="memdesc:a8f90138ef899b636494eee5f49243040"><td class="mdescLeft"> </td><td class="mdescRight">Delete files at the given locations. <br /></td></tr> |
| <tr class="separator:a8f90138ef899b636494eee5f49243040"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4164a9a6aa9d34dd736eb512e20d7207" id="r_a4164a9a6aa9d34dd736eb512e20d7207"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classiceberg_1_1SupportsStorageCredentials.html">SupportsStorageCredentials</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1FileIO.html#a4164a9a6aa9d34dd736eb512e20d7207">AsSupportsStorageCredentials</a> ()</td></tr> |
| <tr class="memdesc:a4164a9a6aa9d34dd736eb512e20d7207"><td class="mdescLeft"> </td><td class="mdescRight">Return storage-credential support when implemented by this <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a>. <br /></td></tr> |
| <tr class="separator:a4164a9a6aa9d34dd736eb512e20d7207"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Pluggable module for reading, writing, and deleting files. </p> |
| <p>This module handles metadata and data file bytes for table IO.</p> |
| <p>Note that these functions are not atomic. For example, if a write fails, the file may be partially written. Implementations should be careful to avoid corrupting metadata files. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4164a9a6aa9d34dd736eb512e20d7207" name="a4164a9a6aa9d34dd736eb512e20d7207"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4164a9a6aa9d34dd736eb512e20d7207">◆ </a></span>AsSupportsStorageCredentials()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classiceberg_1_1SupportsStorageCredentials.html">SupportsStorageCredentials</a> * iceberg::FileIO::AsSupportsStorageCredentials </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return storage-credential support when implemented by this <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a>. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a3ce6216e6a2a8b845c9d29abfcd0e850">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ace7c9ec329017d5a99082739e8578937" name="ace7c9ec329017d5a99082739e8578937"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ace7c9ec329017d5a99082739e8578937">◆ </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">virtual Status iceberg::FileIO::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">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 in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a434e10c12d44fc17a746246172679708">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a8f90138ef899b636494eee5f49243040" name="a8f90138ef899b636494eee5f49243040"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8f90138ef899b636494eee5f49243040">◆ </a></span>DeleteFiles()</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::FileIO::DeleteFiles </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>file_locations</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Delete files at the given locations. </p> |
| <p>Implementations that can delete multiple files efficiently should override this method. The default implementation deletes files sequentially using DeleteFile and returns the first error encountered.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">file_locations</td><td>The locations of the files to delete. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>void if all deletes succeed, or an error code if any delete fails. </dd></dl> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a7a429c4f15101f6060bb56149960cfb4">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a69825dcdb4b389ad96bfc0cb66047f04" name="a69825dcdb4b389ad96bfc0cb66047f04"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a69825dcdb4b389ad96bfc0cb66047f04">◆ </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">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > iceberg::FileIO::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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an input file handle for the given location. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a992176e5ba40af823e6b1b377f7776ab">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a033abce013bf469c31bfeb014a80f729" name="a033abce013bf469c31bfeb014a80f729"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a033abce013bf469c31bfeb014a80f729">◆ </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">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1InputFile.html">InputFile</a> > > iceberg::FileIO::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">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 in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a20daf82c852a4180c81a789d63807eb2">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0d9bbfec5421979aa3c6949dcbb03e9d" name="a0d9bbfec5421979aa3c6949dcbb03e9d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0d9bbfec5421979aa3c6949dcbb03e9d">◆ </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">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::unique_ptr< <a class="el" href="classiceberg_1_1OutputFile.html">OutputFile</a> > > iceberg::FileIO::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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create an output file handle for the given location. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1ResolvingFileIO.html#a162270735464ebdf1cc58a522f0b240e">iceberg::ResolvingFileIO</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a714e3babeac9395ed6ef4b2f5c94a5cd" name="a714e3babeac9395ed6ef4b2f5c94a5cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a714e3babeac9395ed6ef4b2f5c94a5cd">◆ </a></span>ReadFile()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>< std::string > iceberg::FileIO::ReadFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file_location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::optional< 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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read the content of the 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 read. </td></tr> |
| <tr><td class="paramname">length</td><td>The number of bytes to read. Some object storage need to specify the length to read, e.g. S3 <code>GetObject</code> has a Range parameter. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The content of the file if the read succeeded, an error code if the read failed. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a527a78aca1045034250f50a51d8dc0f9" name="a527a78aca1045034250f50a51d8dc0f9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a527a78aca1045034250f50a51d8dc0f9">◆ </a></span>WriteFile()</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::FileIO::WriteFile </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>file_location</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>content</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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Write the given content to the 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 write. </td></tr> |
| <tr><td class="paramname">content</td><td>The content to write to the file. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>void if the write succeeded, an error code if the write failed. </dd></dl> |
| |
| </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> |
