| <!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::Reader 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_1Reader.html">Reader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classopendal_1_1Reader-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">opendal::Reader Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><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></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:a171413a390be13b315e122d33defc531" id="r_a171413a390be13b315e122d33defc531"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html#a171413a390be13b315e122d33defc531">Reader</a> (<a class="el" href="classopendal_1_1Reader.html">Reader</a> &&other) noexcept</td></tr> |
| <tr class="separator:a171413a390be13b315e122d33defc531"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb4c2674a08ee0f1db05da19061d0bbe" id="r_acb4c2674a08ee0f1db05da19061d0bbe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html#acb4c2674a08ee0f1db05da19061d0bbe">~Reader</a> () noexcept</td></tr> |
| <tr class="separator:acb4c2674a08ee0f1db05da19061d0bbe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab625d2835c15a43009b1042f97a19c92" id="r_ab625d2835c15a43009b1042f97a19c92"><td class="memItemLeft" align="right" valign="top">std::streamsize </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html#ab625d2835c15a43009b1042f97a19c92">Read</a> (void *s, std::streamsize n)</td></tr> |
| <tr class="separator:ab625d2835c15a43009b1042f97a19c92"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac7268dac62373d73c5214b7222e5ece3" id="r_ac7268dac62373d73c5214b7222e5ece3"><td class="memItemLeft" align="right" valign="top">std::streampos </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html#ac7268dac62373d73c5214b7222e5ece3">Seek</a> (std::streamoff off, std::ios_base::seekdir way)</td></tr> |
| <tr class="separator:ac7268dac62373d73c5214b7222e5ece3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:a33ff3f826991522d2e77c1c523f33e19" id="r_a33ff3f826991522d2e77c1c523f33e19"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classopendal_1_1Reader.html#a33ff3f826991522d2e77c1c523f33e19">Operator</a></td></tr> |
| <tr class="separator:a33ff3f826991522d2e77c1c523f33e19"><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_1Reader.html" title="Reader is designed to read data from the operator.">Reader</a> is designed to read data from the operator. </p> |
| <p>It provides basic read and seek operations with a stream-like interface. </p><div class="fragment"><div class="line"><a class="code hl_class" href="classopendal_1_1ReaderStream.html">opendal::ReaderStream</a> stream(<span class="keyword">operator</span>.reader(<span class="stringliteral">"path"</span>));</div> |
| <div class="ttc" id="aclassopendal_1_1ReaderStream_html"><div class="ttname"><a href="classopendal_1_1ReaderStream.html">opendal::ReaderStream</a></div><div class="ttdoc">ReaderStream is a stream wrapper of Reader which provides iostream interface. It wraps the Reader to ...</div><div class="ttdef"><b>Definition</b> opendal.hpp:211</div></div> |
| </div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a171413a390be13b315e122d33defc531" name="a171413a390be13b315e122d33defc531"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a171413a390be13b315e122d33defc531">◆ </a></span>Reader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Reader::Reader </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classopendal_1_1Reader.html">Reader</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="acb4c2674a08ee0f1db05da19061d0bbe" name="acb4c2674a08ee0f1db05da19061d0bbe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb4c2674a08ee0f1db05da19061d0bbe">◆ </a></span>~Reader()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">opendal::Reader::~Reader </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="ab625d2835c15a43009b1042f97a19c92" name="ab625d2835c15a43009b1042f97a19c92"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab625d2835c15a43009b1042f97a19c92">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::streamsize opendal::Reader::Read </td> |
| <td>(</td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>s</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::streamsize </td> |
| <td class="paramname"><em>n</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="ac7268dac62373d73c5214b7222e5ece3" name="ac7268dac62373d73c5214b7222e5ece3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac7268dac62373d73c5214b7222e5ece3">◆ </a></span>Seek()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::streampos opendal::Reader::Seek </td> |
| <td>(</td> |
| <td class="paramtype">std::streamoff </td> |
| <td class="paramname"><em>off</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::ios_base::seekdir </td> |
| <td class="paramname"><em>way</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Friends And Related Symbol Documentation</h2> |
| <a id="a33ff3f826991522d2e77c1c523f33e19" name="a33ff3f826991522d2e77c1c523f33e19"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a33ff3f826991522d2e77c1c523f33e19">◆ </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">friend class <a class="el" href="classopendal_1_1Operator.html">Operator</a></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">friend</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </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> |
