blob: 9750aba2ccc33213f881841336733519ba63e6ac [file] [log] [blame]
<!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>Apache OpenDALâ„¢ C++ Binding: opendal Namespace 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" />
<link href="doxygen-awesome.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">Apache OpenDALâ„¢ C++ Binding
</div>
<div id="projectbrief">The C++ binding for Apache OpenDALâ„¢</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&amp;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&amp;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><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">opendal Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceopendal_1_1async" id="r_namespaceopendal_1_1async"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopendal_1_1async.html">async</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceopendal_1_1ffi" id="r_namespaceopendal_1_1ffi"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopendal_1_1ffi.html">ffi</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Entry.html">Entry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The entry of a file or directory. <a href="classopendal_1_1Entry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Lister.html">Lister</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classopendal_1_1Lister.html" title="Lister is designed to list the entries of a directory.">Lister</a> is designed to list the entries of a directory. <a href="classopendal_1_1Lister.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Metadata.html">Metadata</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The metadata of a file or directory. <a href="classopendal_1_1Metadata.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html">Operator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classopendal_1_1Operator.html" title="Operator is the entry for all public APIs.">Operator</a> is the entry for all public APIs. <a href="classopendal_1_1Operator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html">Reader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classopendal_1_1Reader.html" title="Reader is designed to read data from the operator.">Reader</a> is designed to read data from the operator. <a href="classopendal_1_1Reader.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1ReaderStream.html">ReaderStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classopendal_1_1ReaderStream.html" title="ReaderStream is a stream wrapper of Reader which can provide iostream interface. It will keep a Reade...">ReaderStream</a> is a stream wrapper of <a class="el" href="classopendal_1_1Reader.html" title="Reader is designed to read data from the operator.">Reader</a> which can provide <code>iostream</code> interface. It will keep a <a class="el" href="classopendal_1_1Reader.html" title="Reader is designed to read data from the operator.">Reader</a> inside so that you can ignore the lifetime of original <a class="el" href="classopendal_1_1Reader.html" title="Reader is designed to read data from the operator.">Reader</a>. <a href="classopendal_1_1ReaderStream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a02f45e68ae86124b29c583c1cd28d02d" id="r_a02f45e68ae86124b29c583c1cd28d02d"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02d">EntryMode</a> : int { <a class="el" href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02da9fc5887c030f7a3e19821ebec457e719">FILE</a> = 1
, <a class="el" href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02dac1561b120842fabe1310417083827590">DIR</a> = 2
, <a class="el" href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02da696b031073e74bf2cb98e5ef201d4aa3">UNKNOWN</a> = 0
}</td></tr>
<tr class="memdesc:a02f45e68ae86124b29c583c1cd28d02d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The mode of the entry. <a href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02d">More...</a><br /></td></tr>
<tr class="separator:a02f45e68ae86124b29c583c1cd28d02d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a02f45e68ae86124b29c583c1cd28d02d" name="a02f45e68ae86124b29c583c1cd28d02d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02f45e68ae86124b29c583c1cd28d02d">&#9670;&#160;</a></span>EntryMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="namespaceopendal.html#a02f45e68ae86124b29c583c1cd28d02d">opendal::EntryMode</a> : int</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The mode of the entry. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a02f45e68ae86124b29c583c1cd28d02da9fc5887c030f7a3e19821ebec457e719" name="a02f45e68ae86124b29c583c1cd28d02da9fc5887c030f7a3e19821ebec457e719"></a>FILE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a02f45e68ae86124b29c583c1cd28d02dac1561b120842fabe1310417083827590" name="a02f45e68ae86124b29c583c1cd28d02dac1561b120842fabe1310417083827590"></a>DIR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a02f45e68ae86124b29c583c1cd28d02da696b031073e74bf2cb98e5ef201d4aa3" name="a02f45e68ae86124b29c583c1cd28d02da696b031073e74bf2cb98e5ef201d4aa3"></a>UNKNOWN&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>