| <!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"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: dmlc::io::FileSystem 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 style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(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"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="namespacedmlc_1_1io.html">io</a></li><li class="navelem"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html">FileSystem</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classdmlc_1_1io_1_1FileSystem-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::io::FileSystem Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>file system system interface |
| <a href="classdmlc_1_1io_1_1FileSystem.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::io::FileSystem:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1io_1_1FileSystem__coll__graph.png" border="0" usemap="#dmlc_1_1io_1_1FileSystem_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a00b2d929bc6b5899d54165c8af219814"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#a00b2d929bc6b5899d54165c8af219814">~FileSystem</a> ()</td></tr> |
| <tr class="memdesc:a00b2d929bc6b5899d54165c8af219814"><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <a href="classdmlc_1_1io_1_1FileSystem.html#a00b2d929bc6b5899d54165c8af219814">More...</a><br /></td></tr> |
| <tr class="separator:a00b2d929bc6b5899d54165c8af219814"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62577b6d6daa6e34656c5bd76b6cea60"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#a62577b6d6daa6e34656c5bd76b6cea60">GetPathInfo</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path)=0</td></tr> |
| <tr class="memdesc:a62577b6d6daa6e34656c5bd76b6cea60"><td class="mdescLeft"> </td><td class="mdescRight">get information about a path <a href="classdmlc_1_1io_1_1FileSystem.html#a62577b6d6daa6e34656c5bd76b6cea60">More...</a><br /></td></tr> |
| <tr class="separator:a62577b6d6daa6e34656c5bd76b6cea60"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a765105d4aaaf98df0f1bdd21e9d028ea"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#a765105d4aaaf98df0f1bdd21e9d028ea">ListDirectory</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path, std::vector< <a class="el" href="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> > *out_list)=0</td></tr> |
| <tr class="memdesc:a765105d4aaaf98df0f1bdd21e9d028ea"><td class="mdescLeft"> </td><td class="mdescRight">list files in a directory <a href="classdmlc_1_1io_1_1FileSystem.html#a765105d4aaaf98df0f1bdd21e9d028ea">More...</a><br /></td></tr> |
| <tr class="separator:a765105d4aaaf98df0f1bdd21e9d028ea"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac028b881891578c7e2ba50c0a738ba50"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#ac028b881891578c7e2ba50c0a738ba50">ListDirectoryRecursive</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path, std::vector< <a class="el" href="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> > *out_list)</td></tr> |
| <tr class="memdesc:ac028b881891578c7e2ba50c0a738ba50"><td class="mdescLeft"> </td><td class="mdescRight">list files in a directory recursively using ListDirectory <a href="classdmlc_1_1io_1_1FileSystem.html#ac028b881891578c7e2ba50c0a738ba50">More...</a><br /></td></tr> |
| <tr class="separator:ac028b881891578c7e2ba50c0a738ba50"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a507723430906d48bf311190ffebcd79b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdmlc_1_1Stream.html">Stream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#a507723430906d48bf311190ffebcd79b">Open</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path, const char *const flag, bool allow_null=false)=0</td></tr> |
| <tr class="memdesc:a507723430906d48bf311190ffebcd79b"><td class="mdescLeft"> </td><td class="mdescRight">open a stream <a href="classdmlc_1_1io_1_1FileSystem.html#a507723430906d48bf311190ffebcd79b">More...</a><br /></td></tr> |
| <tr class="separator:a507723430906d48bf311190ffebcd79b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4d80e4dcd323d02025f5452a4d895b9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdmlc_1_1SeekStream.html">SeekStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#ad4d80e4dcd323d02025f5452a4d895b9">OpenForRead</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path, bool allow_null=false)=0</td></tr> |
| <tr class="memdesc:ad4d80e4dcd323d02025f5452a4d895b9"><td class="mdescLeft"> </td><td class="mdescRight">open a seekable stream for read <a href="classdmlc_1_1io_1_1FileSystem.html#ad4d80e4dcd323d02025f5452a4d895b9">More...</a><br /></td></tr> |
| <tr class="separator:ad4d80e4dcd323d02025f5452a4d895b9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a51d05555c77063a0944053950ad179f3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdmlc_1_1io_1_1FileSystem.html">FileSystem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1io_1_1FileSystem.html#a51d05555c77063a0944053950ad179f3">GetInstance</a> (const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> &path)</td></tr> |
| <tr class="memdesc:a51d05555c77063a0944053950ad179f3"><td class="mdescLeft"> </td><td class="mdescRight">get singleton of filesystem instance according to <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a> <a href="classdmlc_1_1io_1_1FileSystem.html#a51d05555c77063a0944053950ad179f3">More...</a><br /></td></tr> |
| <tr class="separator:a51d05555c77063a0944053950ad179f3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>file system system interface </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a00b2d929bc6b5899d54165c8af219814"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a00b2d929bc6b5899d54165c8af219814">◆ </a></span>~FileSystem()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual dmlc::io::FileSystem::~FileSystem </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>virtual destructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a51d05555c77063a0944053950ad179f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a51d05555c77063a0944053950ad179f3">◆ </a></span>GetInstance()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classdmlc_1_1io_1_1FileSystem.html">FileSystem</a>* dmlc::io::FileSystem::GetInstance </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>get singleton of filesystem instance according to <a class="el" href="structdmlc_1_1io_1_1URI.html" title="common data structure for URI">URI</a> </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>can be s3://..., hdfs://..., <a href="file://...,">file://...,</a> empty string(will return local) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a corresponding filesystem, report error if we cannot find a matching system </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a62577b6d6daa6e34656c5bd76b6cea60"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a62577b6d6daa6e34656c5bd76b6cea60">◆ </a></span>GetPathInfo()</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="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> dmlc::io::FileSystem::GetPathInfo </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</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>get information about a path </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>the path to the file </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the information about the file </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a765105d4aaaf98df0f1bdd21e9d028ea"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a765105d4aaaf98df0f1bdd21e9d028ea">◆ </a></span>ListDirectory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void dmlc::io::FileSystem::ListDirectory </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> > * </td> |
| <td class="paramname"><em>out_list</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>list files in a directory </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>to the file </td></tr> |
| <tr><td class="paramname">out_list</td><td>the output information about the files </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac028b881891578c7e2ba50c0a738ba50"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac028b881891578c7e2ba50c0a738ba50">◆ </a></span>ListDirectoryRecursive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void dmlc::io::FileSystem::ListDirectoryRecursive </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< <a class="el" href="structdmlc_1_1io_1_1FileInfo.html">FileInfo</a> > * </td> |
| <td class="paramname"><em>out_list</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>list files in a directory recursively using ListDirectory </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>to the file </td></tr> |
| <tr><td class="paramname">out_list</td><td>the output information about the files </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a507723430906d48bf311190ffebcd79b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a507723430906d48bf311190ffebcd79b">◆ </a></span>Open()</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="classdmlc_1_1Stream.html">Stream</a>* dmlc::io::FileSystem::Open </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char *const </td> |
| <td class="paramname"><em>flag</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>allow_null</em> = <code>false</code> </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>open a stream </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>path to file </td></tr> |
| <tr><td class="paramname">flag</td><td>can be "w", "r", "a </td></tr> |
| <tr><td class="paramname">allow_null</td><td>whether NULL can be returned, or directly report error </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the created stream, can be NULL when allow_null == true and file do not exist </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad4d80e4dcd323d02025f5452a4d895b9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad4d80e4dcd323d02025f5452a4d895b9">◆ </a></span>OpenForRead()</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="classdmlc_1_1SeekStream.html">SeekStream</a>* dmlc::io::FileSystem::OpenForRead </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="structdmlc_1_1io_1_1URI.html">URI</a> & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>allow_null</em> = <code>false</code> </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>open a seekable stream for read </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>the path to the file </td></tr> |
| <tr><td class="paramname">allow_null</td><td>whether NULL can be returned, or directly report error </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the created stream, can be NULL when allow_null == true and file do not exist </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h_source.html">io.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
