CDevJoud/Minecraft-Community-Edition
1
0
Fork 0
mirror of https://github.com/CDevJoud/Minecraft-Community-Edition.git synced 2026-07-16 14:40:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dev
Minecraft-Community-Edition/doc/html/classmce_1_1_file_input_stream.html
Joud Kandeel ef7efddeef added docs
2026-04-01 20:47:40 +02:00

334 lines
15 KiB
HTML
Raw Permalink Blame History

<!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.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Minecraft Community Edition: mce::FileInputStream Class Reference</title>
<link rel="icon" href="logo channel.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Minecraft Community Edition<span id="projectnumber">&#160;0.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('classmce_1_1_file_input_stream.html','','classmce_1_1_file_input_stream-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle"><div class="title">mce::FileInputStream Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for mce::FileInputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classmce_1_1_file_input_stream.png" usemap="#mce_3A_3AFileInputStream_map" alt=""/>
<map id="mce_3A_3AFileInputStream_map" name="mce_3A_3AFileInputStream_map">
<area href="classmce_1_1_input_stream.html" alt="mce::InputStream" shape="rect" coords="0,0,128,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3eb6e463ae37bd285915c3b41fd5f53e" id="r_a3eb6e463ae37bd285915c3b41fd5f53e"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#a3eb6e463ae37bd285915c3b41fd5f53e">open</a> (const std::string &amp;file)</td></tr>
<tr class="memdesc:a3eb6e463ae37bd285915c3b41fd5f53e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the stream and opens a file. <br /></td></tr>
<tr class="memitem:a26a715bb8bb53cb3cb1b1de6059af07a" id="r_a26a715bb8bb53cb3cb1b1de6059af07a"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#a26a715bb8bb53cb3cb1b1de6059af07a">isOpen</a> () const</td></tr>
<tr class="memitem:abe975adc14ec46da5085aa396bf6bb17" id="r_abe975adc14ec46da5085aa396bf6bb17"><td class="memItemLeft"><a id="abe975adc14ec46da5085aa396bf6bb17" name="abe975adc14ec46da5085aa396bf6bb17"></a>
void&#160;</td><td class="memItemRight"><b>close</b> ()</td></tr>
<tr class="memdesc:abe975adc14ec46da5085aa396bf6bb17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the file. <br /></td></tr>
<tr class="memitem:a6bf0dffd4568ef1638aed7aafa2ecd00" id="r_a6bf0dffd4568ef1638aed7aafa2ecd00"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a6bf0dffd4568ef1638aed7aafa2ecd00">read</a> (void *buffer, size_t size) override</td></tr>
<tr class="memdesc:a6bf0dffd4568ef1638aed7aafa2ecd00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads from the input stream. <br /></td></tr>
<tr class="memitem:a8a46a90250858695bf282ed1fc601cc8" id="r_a8a46a90250858695bf282ed1fc601cc8"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a8a46a90250858695bf282ed1fc601cc8">seek</a> (size_t position) override</td></tr>
<tr class="memdesc:a8a46a90250858695bf282ed1fc601cc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the current position the stream is reading. <br /></td></tr>
<tr class="memitem:a3f974238eeb105b85e455145cc85518a" id="r_a3f974238eeb105b85e455145cc85518a"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a3f974238eeb105b85e455145cc85518a">tell</a> () override</td></tr>
<tr class="memitem:a271ddb30e8c58bbb759c03a6970277e1" id="r_a271ddb30e8c58bbb759c03a6970277e1"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a271ddb30e8c58bbb759c03a6970277e1">getSize</a> () override</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-static-attribs" class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a1335942fa519648022f82df1aa2a1239" id="r_a1335942fa519648022f82df1aa2a1239"><td class="memItemLeft"><a id="a1335942fa519648022f82df1aa2a1239" name="a1335942fa519648022f82df1aa2a1239"></a>
static constexpr size_t&#160;</td><td class="memItemRight"><b>FILE_NOT_FOUND</b> = 0</td></tr>
<tr class="memitem:ae9c6b696ce6e8162df6638a75c81f167" id="r_ae9c6b696ce6e8162df6638a75c81f167"><td class="memItemLeft"><a id="ae9c6b696ce6e8162df6638a75c81f167" name="ae9c6b696ce6e8162df6638a75c81f167"></a>
static constexpr size_t&#160;</td><td class="memItemRight"><b>INVALID_FILE_SIZE</b> = ~(0)</td></tr>
<tr class="memitem:a49d42d75bf42c64c269c39c4cba06882" id="r_a49d42d75bf42c64c269c39c4cba06882"><td class="memItemLeft"><a id="a49d42d75bf42c64c269c39c4cba06882" name="a49d42d75bf42c64c269c39c4cba06882"></a>
static constexpr size_t&#160;</td><td class="memItemRight"><b>INVALID_FILE_POSITION</b> = ~(0)</td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a271ddb30e8c58bbb759c03a6970277e1" name="a271ddb30e8c58bbb759c03a6970277e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a271ddb30e8c58bbb759c03a6970277e1">&#9670;&#160;</a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mce::FileInputStream::getSize </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The size of the stream in bytes </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a661d85973a2683a217252c36f47da682">mce::InputStream</a>.</p>
</div>
</div>
<a id="a26a715bb8bb53cb3cb1b1de6059af07a" name="a26a715bb8bb53cb3cb1b1de6059af07a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26a715bb8bb53cb3cb1b1de6059af07a">&#9670;&#160;</a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mce::FileInputStream::isOpen </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>True if the file was successfully opened </dd></dl>
</div>
</div>
<a id="a3eb6e463ae37bd285915c3b41fd5f53e" name="a3eb6e463ae37bd285915c3b41fd5f53e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eb6e463ae37bd285915c3b41fd5f53e">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mce::FileInputStream::open </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>file</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs the stream and opens a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The path (absolute or relative) to the file</td></tr>
</table>
</dd>
</dl>
<p>Opens a file to read from </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The path (absolute or relative) to the file </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6bf0dffd4568ef1638aed7aafa2ecd00" name="a6bf0dffd4568ef1638aed7aafa2ecd00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bf0dffd4568ef1638aed7aafa2ecd00">&#9670;&#160;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mce::FileInputStream::read </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads from the input stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>The buffer to read the bytes into </td></tr>
<tr><td class="paramname">size</td><td>The amount of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The amount of bytes written </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a548e3aeadfb9222019bcb59a39848d9e">mce::InputStream</a>.</p>
</div>
</div>
<a id="a8a46a90250858695bf282ed1fc601cc8" name="a8a46a90250858695bf282ed1fc601cc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a46a90250858695bf282ed1fc601cc8">&#9670;&#160;</a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mce::FileInputStream::seek </td>
<td>(</td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>position</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the current position the stream is reading. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The position to seek the input stream to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The position the input stream is at now </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a4c7ee56f44922aa52b608d44cbc4235c">mce::InputStream</a>.</p>
</div>
</div>
<a id="a3f974238eeb105b85e455145cc85518a" name="a3f974238eeb105b85e455145cc85518a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f974238eeb105b85e455145cc85518a">&#9670;&#160;</a></span>tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mce::FileInputStream::tell </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The current position the stream is at </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a38cee7380aef36c4db0287e38609b4d7">mce::InputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>IO/Stream/<a class="el" href="_file_input_stream_8hpp_source.html">FileInputStream.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>mce</b></li><li class="navelem"><a href="classmce_1_1_file_input_stream.html">FileInputStream</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink