| <!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::Operator 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" /> |
| <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&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="namespaceopendal.html">opendal</a></li><li class="navelem"><a class="el" href="classopendal_1_1Operator.html">Operator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classopendal_1_1Operator-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">opendal::Operator Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><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></p> |
| |
| <p><code>#include <<a class="el" href="opendal_8hpp_source.html">opendal.hpp</a>></code></p> |
| <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:a509823c50c3d98aa0cd27aa5927754c8" id="r_a509823c50c3d98aa0cd27aa5927754c8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a509823c50c3d98aa0cd27aa5927754c8">Operator</a> () noexcept</td></tr> |
| <tr class="separator:a509823c50c3d98aa0cd27aa5927754c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa31eda4e80c50287698cfec92a6c52ee" id="r_aa31eda4e80c50287698cfec92a6c52ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#aa31eda4e80c50287698cfec92a6c52ee">Operator</a> (std::string_view scheme, const std::unordered_map< std::string, std::string > &config={})</td></tr> |
| <tr class="memdesc:aa31eda4e80c50287698cfec92a6c52ee"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="classopendal_1_1Operator.html" title="Operator is the entry for all public APIs.">Operator</a> object. <br /></td></tr> |
| <tr class="separator:aa31eda4e80c50287698cfec92a6c52ee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a82ff5d64072c83adc557385519669c20" id="r_a82ff5d64072c83adc557385519669c20"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a82ff5d64072c83adc557385519669c20">Operator</a> (const <a class="el" href="classopendal_1_1Operator.html">Operator</a> &)=delete</td></tr> |
| <tr class="separator:a82ff5d64072c83adc557385519669c20"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa3e0249cc7cb6ca22592bff12ff39d8b" id="r_aa3e0249cc7cb6ca22592bff12ff39d8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Operator.html">Operator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#aa3e0249cc7cb6ca22592bff12ff39d8b">operator=</a> (const <a class="el" href="classopendal_1_1Operator.html">Operator</a> &)=delete</td></tr> |
| <tr class="separator:aa3e0249cc7cb6ca22592bff12ff39d8b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63a2c093e6d8024175c1be0393d10812" id="r_a63a2c093e6d8024175c1be0393d10812"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a63a2c093e6d8024175c1be0393d10812">Operator</a> (<a class="el" href="classopendal_1_1Operator.html">Operator</a> &&other) noexcept</td></tr> |
| <tr class="separator:a63a2c093e6d8024175c1be0393d10812"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acacc568bd1bf3bee1a62d6704d2c74ec" id="r_acacc568bd1bf3bee1a62d6704d2c74ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Operator.html">Operator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#acacc568bd1bf3bee1a62d6704d2c74ec">operator=</a> (<a class="el" href="classopendal_1_1Operator.html">Operator</a> &&other) noexcept</td></tr> |
| <tr class="separator:acacc568bd1bf3bee1a62d6704d2c74ec"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74de3a3e4d5899300acf3b5cb459dd30" id="r_a74de3a3e4d5899300acf3b5cb459dd30"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a74de3a3e4d5899300acf3b5cb459dd30">~Operator</a> () noexcept</td></tr> |
| <tr class="separator:a74de3a3e4d5899300acf3b5cb459dd30"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a67e7ce696a2416b6a84279bf03f33756" id="r_a67e7ce696a2416b6a84279bf03f33756"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a67e7ce696a2416b6a84279bf03f33756">Available</a> () const</td></tr> |
| <tr class="memdesc:a67e7ce696a2416b6a84279bf03f33756"><td class="mdescLeft"> </td><td class="mdescRight">Check if the operator is available. <br /></td></tr> |
| <tr class="separator:a67e7ce696a2416b6a84279bf03f33756"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7f4b4f22ee3dc5047ade885b15269f9c" id="r_a7f4b4f22ee3dc5047ade885b15269f9c"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a7f4b4f22ee3dc5047ade885b15269f9c">Read</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:a7f4b4f22ee3dc5047ade885b15269f9c"><td class="mdescLeft"> </td><td class="mdescRight">Read data from the operator. <br /></td></tr> |
| <tr class="separator:a7f4b4f22ee3dc5047ade885b15269f9c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7e1de12b0be79771bd46d006b56d93c" id="r_ae7e1de12b0be79771bd46d006b56d93c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#ae7e1de12b0be79771bd46d006b56d93c">Write</a> (std::string_view path, std::string_view data)</td></tr> |
| <tr class="memdesc:ae7e1de12b0be79771bd46d006b56d93c"><td class="mdescLeft"> </td><td class="mdescRight">Write data to the operator. <br /></td></tr> |
| <tr class="separator:ae7e1de12b0be79771bd46d006b56d93c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1a6500010c81a91803270cfd8c99b080" id="r_a1a6500010c81a91803270cfd8c99b080"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Reader.html">Reader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a1a6500010c81a91803270cfd8c99b080">GetReader</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:a1a6500010c81a91803270cfd8c99b080"><td class="mdescLeft"> </td><td class="mdescRight">Read data from the operator. <br /></td></tr> |
| <tr class="separator:a1a6500010c81a91803270cfd8c99b080"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a85f76fce5d777095564650d7f45c5805" id="r_a85f76fce5d777095564650d7f45c5805"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a85f76fce5d777095564650d7f45c5805">IsExist</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:a85f76fce5d777095564650d7f45c5805"><td class="mdescLeft"> </td><td class="mdescRight">Check if the path exists. <br /></td></tr> |
| <tr class="separator:a85f76fce5d777095564650d7f45c5805"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6723ca1a73b268627ec8ffc4dafd6c4a" id="r_a6723ca1a73b268627ec8ffc4dafd6c4a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a6723ca1a73b268627ec8ffc4dafd6c4a">Exists</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:a6723ca1a73b268627ec8ffc4dafd6c4a"><td class="mdescLeft"> </td><td class="mdescRight">Check if the path exists. <br /></td></tr> |
| <tr class="separator:a6723ca1a73b268627ec8ffc4dafd6c4a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac04d7941e9f6455ad5280d0c86dd73d0" id="r_ac04d7941e9f6455ad5280d0c86dd73d0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#ac04d7941e9f6455ad5280d0c86dd73d0">CreateDir</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:ac04d7941e9f6455ad5280d0c86dd73d0"><td class="mdescLeft"> </td><td class="mdescRight">Create a directory. <br /></td></tr> |
| <tr class="separator:ac04d7941e9f6455ad5280d0c86dd73d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad05afffbd80724939d64162e84f6fc8e" id="r_ad05afffbd80724939d64162e84f6fc8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#ad05afffbd80724939d64162e84f6fc8e">Copy</a> (std::string_view src, std::string_view dst)</td></tr> |
| <tr class="memdesc:ad05afffbd80724939d64162e84f6fc8e"><td class="mdescLeft"> </td><td class="mdescRight">Copy a file from src to dst. <br /></td></tr> |
| <tr class="separator:ad05afffbd80724939d64162e84f6fc8e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a61855cacd77bf15bdb5b33d0724110aa" id="r_a61855cacd77bf15bdb5b33d0724110aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a61855cacd77bf15bdb5b33d0724110aa">Rename</a> (std::string_view src, std::string_view dst)</td></tr> |
| <tr class="memdesc:a61855cacd77bf15bdb5b33d0724110aa"><td class="mdescLeft"> </td><td class="mdescRight">Rename a file from src to dst. <br /></td></tr> |
| <tr class="separator:a61855cacd77bf15bdb5b33d0724110aa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a065e358438cebb5a4b684360ad64756b" id="r_a065e358438cebb5a4b684360ad64756b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a065e358438cebb5a4b684360ad64756b">Remove</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:a065e358438cebb5a4b684360ad64756b"><td class="mdescLeft"> </td><td class="mdescRight">Remove a file or directory. <br /></td></tr> |
| <tr class="separator:a065e358438cebb5a4b684360ad64756b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8906229a57a6e39eef4f730fabcb6c0" id="r_af8906229a57a6e39eef4f730fabcb6c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Metadata.html">Metadata</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#af8906229a57a6e39eef4f730fabcb6c0">Stat</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:af8906229a57a6e39eef4f730fabcb6c0"><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata of a file or directory. <br /></td></tr> |
| <tr class="separator:af8906229a57a6e39eef4f730fabcb6c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2f7b959687103109410ccee7bc96e29" id="r_af2f7b959687103109410ccee7bc96e29"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classopendal_1_1Entry.html">Entry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#af2f7b959687103109410ccee7bc96e29">List</a> (std::string_view path)</td></tr> |
| <tr class="memdesc:af2f7b959687103109410ccee7bc96e29"><td class="mdescLeft"> </td><td class="mdescRight">List the entries of a directory. <br /></td></tr> |
| <tr class="separator:af2f7b959687103109410ccee7bc96e29"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaf870597eba9bf2fc8fd6a6970053531" id="r_aaf870597eba9bf2fc8fd6a6970053531"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Lister.html">Lister</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#aaf870597eba9bf2fc8fd6a6970053531">GetLister</a> (std::string_view path)</td></tr> |
| <tr class="separator:aaf870597eba9bf2fc8fd6a6970053531"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e211d3e2ae2da77ed3552f7d32f0bf6" id="r_a5e211d3e2ae2da77ed3552f7d32f0bf6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classopendal_1_1Capability.html">Capability</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Operator.html#a5e211d3e2ae2da77ed3552f7d32f0bf6">Info</a> ()</td></tr> |
| <tr class="separator:a5e211d3e2ae2da77ed3552f7d32f0bf6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><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. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a509823c50c3d98aa0cd27aa5927754c8" name="a509823c50c3d98aa0cd27aa5927754c8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a509823c50c3d98aa0cd27aa5927754c8">◆ </a></span>Operator() <span class="overload">[1/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Operator::Operator </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="aa31eda4e80c50287698cfec92a6c52ee" name="aa31eda4e80c50287698cfec92a6c52ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa31eda4e80c50287698cfec92a6c52ee">◆ </a></span>Operator() <span class="overload">[2/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Operator::Operator </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>scheme</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::unordered_map< std::string, std::string > & </td> |
| <td class="paramname"><em>config</em> = <code>{}</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a new <a class="el" href="classopendal_1_1Operator.html" title="Operator is the entry for all public APIs.">Operator</a> object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">scheme</td><td>The scheme of the operator, same as the name of rust doc </td></tr> |
| <tr><td class="paramname">config</td><td>The configuration of the operator, same as the service doc </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a82ff5d64072c83adc557385519669c20" name="a82ff5d64072c83adc557385519669c20"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a82ff5d64072c83adc557385519669c20">◆ </a></span>Operator() <span class="overload">[3/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Operator::Operator </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classopendal_1_1Operator.html">Operator</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">delete</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a63a2c093e6d8024175c1be0393d10812" name="a63a2c093e6d8024175c1be0393d10812"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63a2c093e6d8024175c1be0393d10812">◆ </a></span>Operator() <span class="overload">[4/4]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Operator::Operator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classopendal_1_1Operator.html">Operator</a> && </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a74de3a3e4d5899300acf3b5cb459dd30" name="a74de3a3e4d5899300acf3b5cb459dd30"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74de3a3e4d5899300acf3b5cb459dd30">◆ </a></span>~Operator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Operator::~Operator </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a67e7ce696a2416b6a84279bf03f33756" name="a67e7ce696a2416b6a84279bf03f33756"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a67e7ce696a2416b6a84279bf03f33756">◆ </a></span>Available()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool opendal::Operator::Available </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if the operator is available. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if the operator is available, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad05afffbd80724939d64162e84f6fc8e" name="ad05afffbd80724939d64162e84f6fc8e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad05afffbd80724939d64162e84f6fc8e">◆ </a></span>Copy()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void opendal::Operator::Copy </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>src</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>dst</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy a file from src to dst. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>The source path </td></tr> |
| <tr><td class="paramname">dst</td><td>The destination path </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac04d7941e9f6455ad5280d0c86dd73d0" name="ac04d7941e9f6455ad5280d0c86dd73d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac04d7941e9f6455ad5280d0c86dd73d0">◆ </a></span>CreateDir()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void opendal::Operator::CreateDir </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a directory. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the directory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6723ca1a73b268627ec8ffc4dafd6c4a" name="a6723ca1a73b268627ec8ffc4dafd6c4a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6723ca1a73b268627ec8ffc4dafd6c4a">◆ </a></span>Exists()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool opendal::Operator::Exists </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if the path exists. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path to check </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the path exists, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aaf870597eba9bf2fc8fd6a6970053531" name="aaf870597eba9bf2fc8fd6a6970053531"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaf870597eba9bf2fc8fd6a6970053531">◆ </a></span>GetLister()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classopendal_1_1Lister.html">Lister</a> opendal::Operator::GetLister </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a1a6500010c81a91803270cfd8c99b080" name="a1a6500010c81a91803270cfd8c99b080"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1a6500010c81a91803270cfd8c99b080">◆ </a></span>GetReader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classopendal_1_1Reader.html">Reader</a> opendal::Operator::GetReader </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read data from the operator. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the data </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The reader of the data </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5e211d3e2ae2da77ed3552f7d32f0bf6" name="a5e211d3e2ae2da77ed3552f7d32f0bf6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e211d3e2ae2da77ed3552f7d32f0bf6">◆ </a></span>Info()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classopendal_1_1Capability.html">Capability</a> opendal::Operator::Info </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a85f76fce5d777095564650d7f45c5805" name="a85f76fce5d777095564650d7f45c5805"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a85f76fce5d777095564650d7f45c5805">◆ </a></span>IsExist()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool opendal::Operator::IsExist </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if the path exists. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path to check </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the path exists, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="af2f7b959687103109410ccee7bc96e29" name="af2f7b959687103109410ccee7bc96e29"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af2f7b959687103109410ccee7bc96e29">◆ </a></span>List()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector< <a class="el" href="classopendal_1_1Entry.html">Entry</a> > opendal::Operator::List </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>List the entries of a directory. </p> |
| <dl class="section note"><dt>Note</dt><dd>The returned entries are sorted by name.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the directory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The entries of the directory </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa3e0249cc7cb6ca22592bff12ff39d8b" name="aa3e0249cc7cb6ca22592bff12ff39d8b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa3e0249cc7cb6ca22592bff12ff39d8b">◆ </a></span>operator=() <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"><a class="el" href="classopendal_1_1Operator.html">Operator</a> & opendal::Operator::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classopendal_1_1Operator.html">Operator</a> & </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">delete</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="acacc568bd1bf3bee1a62d6704d2c74ec" name="acacc568bd1bf3bee1a62d6704d2c74ec"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acacc568bd1bf3bee1a62d6704d2c74ec">◆ </a></span>operator=() <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"><a class="el" href="classopendal_1_1Operator.html">Operator</a> & opendal::Operator::operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classopendal_1_1Operator.html">Operator</a> && </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a7f4b4f22ee3dc5047ade885b15269f9c" name="a7f4b4f22ee3dc5047ade885b15269f9c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7f4b4f22ee3dc5047ade885b15269f9c">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string opendal::Operator::Read </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read data from the operator. </p> |
| <dl class="section note"><dt>Note</dt><dd>The operation will make unnecessary copy. So we recommend to use the <code>GetReader</code> method.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the data </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The data read from the operator </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a065e358438cebb5a4b684360ad64756b" name="a065e358438cebb5a4b684360ad64756b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a065e358438cebb5a4b684360ad64756b">◆ </a></span>Remove()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void opendal::Operator::Remove </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Remove a file or directory. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the file or directory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a61855cacd77bf15bdb5b33d0724110aa" name="a61855cacd77bf15bdb5b33d0724110aa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a61855cacd77bf15bdb5b33d0724110aa">◆ </a></span>Rename()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void opendal::Operator::Rename </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>src</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>dst</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Rename a file from src to dst. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">src</td><td>The source path </td></tr> |
| <tr><td class="paramname">dst</td><td>The destination path </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af8906229a57a6e39eef4f730fabcb6c0" name="af8906229a57a6e39eef4f730fabcb6c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8906229a57a6e39eef4f730fabcb6c0">◆ </a></span>Stat()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classopendal_1_1Metadata.html">Metadata</a> opendal::Operator::Stat </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the metadata of a file or directory. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the file or directory </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The metadata of the file or directory </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae7e1de12b0be79771bd46d006b56d93c" name="ae7e1de12b0be79771bd46d006b56d93c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7e1de12b0be79771bd46d006b56d93c">◆ </a></span>Write()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void opendal::Operator::Write </td> |
| <td>(</td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string_view </td> |
| <td class="paramname"><em>data</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Write data to the operator. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">path</td><td>The path of the data </td></tr> |
| <tr><td class="paramname">data</td><td>The data to write </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/runner/work/opendal/opendal/bindings/cpp/include/<a class="el" href="opendal_8hpp_source.html">opendal.hpp</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> |
