| <!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/file_io.h Source File</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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">file_io.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "iceberg/iceberg_export.h"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "iceberg/result.h"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">namespace </span>iceberg {</div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="foldopen" id="foldopen00040" data-start="{" data-end="};"> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileIO.html"> 40</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1FileIO.html">FileIO</a> {</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_class" href="classiceberg_1_1FileIO.html">FileIO</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1FileIO.html">~FileIO</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="foldopen" id="foldopen00052" data-start="{" data-end="}"> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileIO.html#a714e3babeac9395ed6ef4b2f5c94a5cd"> 52</a></span> <span class="keyword">virtual</span> Result<std::string> <a class="code hl_function" href="classiceberg_1_1FileIO.html#a714e3babeac9395ed6ef4b2f5c94a5cd">ReadFile</a>(<span class="keyword">const</span> std::string& file_location,</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> std::optional<size_t> length) {</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="comment">// We provide a default implementation to avoid Windows linker error LNK2019.</span></div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> NotImplemented(<span class="stringliteral">"ReadFile not implemented"</span>);</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> }</div> |
| </div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="foldopen" id="foldopen00065" data-start="{" data-end="}"> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileIO.html#a527a78aca1045034250f50a51d8dc0f9"> 65</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1FileIO.html#a527a78aca1045034250f50a51d8dc0f9">WriteFile</a>(<span class="keyword">const</span> std::string& file_location, std::string_view content) {</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> NotImplemented(<span class="stringliteral">"WriteFile not implemented"</span>);</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> }</div> |
| </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="foldopen" id="foldopen00073" data-start="{" data-end="}"> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937"> 73</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937">DeleteFile</a>(<span class="keyword">const</span> std::string& file_location) {</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> NotImplemented(<span class="stringliteral">"DeleteFile not implemented"</span>);</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div> |
| </div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>};</div> |
| </div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1FileIO_html"><div class="ttname"><a href="classiceberg_1_1FileIO.html">iceberg::FileIO</a></div><div class="ttdoc">Pluggable module for reading, writing, and deleting files.</div><div class="ttdef"><b>Definition</b> file_io.h:40</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileIO_html_a527a78aca1045034250f50a51d8dc0f9"><div class="ttname"><a href="classiceberg_1_1FileIO.html#a527a78aca1045034250f50a51d8dc0f9">iceberg::FileIO::WriteFile</a></div><div class="ttdeci">virtual Status WriteFile(const std::string &file_location, std::string_view content)</div><div class="ttdoc">Write the given content to the file at the given location.</div><div class="ttdef"><b>Definition</b> file_io.h:65</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileIO_html_a714e3babeac9395ed6ef4b2f5c94a5cd"><div class="ttname"><a href="classiceberg_1_1FileIO.html#a714e3babeac9395ed6ef4b2f5c94a5cd">iceberg::FileIO::ReadFile</a></div><div class="ttdeci">virtual Result< std::string > ReadFile(const std::string &file_location, std::optional< size_t > length)</div><div class="ttdoc">Read the content of the file at the given location.</div><div class="ttdef"><b>Definition</b> file_io.h:52</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileIO_html_ace7c9ec329017d5a99082739e8578937"><div class="ttname"><a href="classiceberg_1_1FileIO.html#ace7c9ec329017d5a99082739e8578937">iceberg::FileIO::DeleteFile</a></div><div class="ttdeci">virtual Status DeleteFile(const std::string &file_location)</div><div class="ttdoc">Delete a file at the given location.</div><div class="ttdef"><b>Definition</b> file_io.h:73</div></div> |
| </div><!-- fragment --></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> |
