GitHub build 105

api_user/classsimgrid_1_1module_1_1fs_1_1_file.html

@@ -53,7 +53,6 @@
               <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">simgrid::module::fs::File</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs4FileE"><code class="docutils literal notranslate"><span class="pre">File</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs4File5closeEv"><code class="docutils literal notranslate"><span class="pre">File::close()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE"><code class="docutils literal notranslate"><span class="pre">File::get_num_bytes_read()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4NK7simgrid6module2fs4File21get_num_bytes_writtenERKN3s4u5IoPtrE"><code class="docutils literal notranslate"><span class="pre">File::get_num_bytes_written()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs4File4readERKNSt6stringEb"><code class="docutils literal notranslate"><span class="pre">File::read()</span></code></a></li>
@@ -111,12 +110,6 @@
 <dd><p>A class that implemented a file abstraction. </p>
 <div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
-<dl class="cpp function">
-<dt class="sig sig-object cpp" id="_CPPv4N7simgrid6module2fs4File5closeEv">
-<span id="_CPPv3N7simgrid6module2fs4File5closeEv"></span><span id="_CPPv2N7simgrid6module2fs4File5closeEv"></span><span id="simgrid::module::fs::File::close"></span><span class="target" id="classsimgrid_1_1module_1_1fs_1_1_file_1aebcf64e54396644f412de5309d14015b"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">close</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7simgrid6module2fs4File5closeEv" title="Link to this definition"></a><br /></dt>
-<dd><p>Closes the file. After closing, using the file has undefined behavior. </p>
-</dd></dl>
-
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE">
 <span id="_CPPv3NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE"></span><span id="_CPPv2NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE"></span><span id="simgrid::module::fs::File::get_num_bytes_read__s4u::IoPtrCRC"></span><span class="target" id="classsimgrid_1_1module_1_1fs_1_1_file_1ab1ba1ad83c1cf5488814de3b11a590ad"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">sg_size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_num_bytes_read</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">s4u</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IoPtr</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">read</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE" title="Link to this definition"></a><br /></dt>

api_user/classsimgrid_1_1module_1_1fs_1_1_file_system.html

@@ -54,6 +54,7 @@
 <li class="toctree-l1"><a class="reference internal" href="classsimgrid_1_1module_1_1fs_1_1_file.html">simgrid::module::fs::File</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">simgrid::module::fs::FileSystem</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs10FileSystemE"><code class="docutils literal notranslate"><span class="pre">FileSystem</span></code></a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE"><code class="docutils literal notranslate"><span class="pre">FileSystem::close()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">FileSystem::create_file()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs10FileSystem16directory_existsERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">FileSystem::directory_exists()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#_CPPv4N7simgrid6module2fs10FileSystem11file_existsERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">FileSystem::file_exists()</span></code></a></li>
@@ -108,6 +109,17 @@
 <dd><p>A class that implements a file system abstraction. </p>
 <div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE">
+<span id="_CPPv3N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE"></span><span id="_CPPv2N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE"></span><span id="simgrid::module::fs::FileSystem::close__std::shared_ptr:File:"></span><span class="target" id="classsimgrid_1_1module_1_1fs_1_1_file_system_1ac0c9110b983533367e04c7effab1bed1"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">close</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre">&lt;</span></span><a class="reference internal" href="classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4N7simgrid6module2fs4FileE" title="simgrid::module::fs::File"><span class="n"><span class="pre">File</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">f</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE" title="Link to this definition"></a><br /></dt>
+<dd><p>Closes the file. After closing, using the file has undefined behavior. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>file</strong> – a shared pointer on a <a class="reference internal" href="classsimgrid_1_1module_1_1fs_1_1_file.html#classsimgrid_1_1module_1_1fs_1_1_file"><span class="std std-ref">File</span></a></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE">
 <span id="_CPPv3N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE"></span><span id="simgrid::module::fs::FileSystem::create_file__ssCR.ssCR"></span><span class="target" id="classsimgrid_1_1module_1_1fs_1_1_file_system_1abc502f620b7ffb3d213bce9b4595103d"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">create_file</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">full_path</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE" title="Link to this definition"></a><br /></dt>

genindex.html

@@ -91,8 +91,6 @@ <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4N7simgrid6module2fs4FileE">simgrid::module::fs::File (C++ class)</a>
-</li>
-      <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4N7simgrid6module2fs4File5closeEv">simgrid::module::fs::File::close (C++ function)</a>
 </li>
       <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4NK7simgrid6module2fs4File18get_num_bytes_readERKN3s4u5IoPtrE">simgrid::module::fs::File::get_num_bytes_read (C++ function)</a>
 </li>
@@ -113,6 +111,8 @@ <h2 id="S">S</h2>
       <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4N7simgrid6module2fs4File11write_asyncE9sg_size_t">simgrid::module::fs::File::write_async (C++ function)</a>, <a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file.html#_CPPv4N7simgrid6module2fs4File11write_asyncERKNSt6stringE">[1]</a>
 </li>
       <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file_system.html#_CPPv4N7simgrid6module2fs10FileSystemE">simgrid::module::fs::FileSystem (C++ class)</a>
+</li>
+      <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file_system.html#_CPPv4N7simgrid6module2fs10FileSystem5closeENSt10shared_ptrI4FileEE">simgrid::module::fs::FileSystem::close (C++ function)</a>
 </li>
       <li><a href="api_user/classsimgrid_1_1module_1_1fs_1_1_file_system.html#_CPPv4N7simgrid6module2fs10FileSystem11create_fileERKNSt6stringERKNSt6stringE">simgrid::module::fs::FileSystem::create_file (C++ function)</a>
 </li>