CDevJoud/Minecraft-Community-Edition
1
0
Fork 0
mirror of https://github.com/CDevJoud/Minecraft-Community-Edition.git synced 2026-07-16 05:20:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dev
Minecraft-Community-Edition/doc/html/_file_output_stream_8hpp_source.html
Joud Kandeel 0f6c725345 updated the docs
2026-04-02 13:39:23 +02:00

160 lines
17 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: Minecraft-Community-Edition/IO/Stream/FileOutputStream.hpp Source File</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>
<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('_file_output_stream_8hpp_source.html','',''); });
</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">FileOutputStream.hpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &quot;..\..\Platform.hpp&quot;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;OutputStream.hpp&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef MCE_PLATFORM_WINDOWS</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#undef INVALID_FILE_SIZE</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;cstdio&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span>mce::io::stream {</div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1_file_output_stream.html"> 18</a></span> <span class="keyword">class </span><a class="code hl_function" href="classmce_1_1io_1_1_file_output_stream.html#afa07782fd21742c833545744a907a163">FileOutputStream</a> final : <span class="keyword">public</span> OutputStream {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afa07782fd21742c833545744a907a163"> 23</a></span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afa07782fd21742c833545744a907a163">FileOutputStream</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afd682afed600aa9f2efda8965c5c5bf1"> 30</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afd682afed600aa9f2efda8965c5c5bf1">open</a>(<span class="keyword">const</span> std::string&amp; file);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#aa5850054846c0e24e244ec8f137f80c8"> 36</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#aa5850054846c0e24e244ec8f137f80c8">isOpen</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a957bc7e779b3967f65d45ab6d7a81ce8"> 41</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a957bc7e779b3967f65d45ab6d7a81ce8">close</a>();</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a579d72d46213ac70df80d73e98a7beec"> 49</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a579d72d46213ac70df80d73e98a7beec">write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a6eeb71a3396de98cbf0a6ae9acd43f81"> 56</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a6eeb71a3396de98cbf0a6ae9acd43f81">seek</a>(<span class="keywordtype">size_t</span> position) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afe6e6ec5cf6a1396faa94130cce9cf43"> 62</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afe6e6ec5cf6a1396faa94130cce9cf43">tell</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a8d5e97b01178866c7d898d06872b8223"> 68</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a8d5e97b01178866c7d898d06872b8223">getSize</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a339cf5f940b99e786c8573df087ec180"> 76</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a339cf5f940b99e786c8573df087ec180">INVALID_FILE_SIZE</a> = ~(0);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a7452adddb31d4282113a11418cdf26c9"> 81</a></span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a7452adddb31d4282113a11418cdf26c9">INVALID_FILE_POSITION</a> = ~(0);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="preprocessor">#ifdef MCE_PLATFORM_WINDOWS</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span>* hFile = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#elif defined(MCE_PLATFORM_LINUX) || defined(MCE_PLATFORM_MACOS)</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> std::FILE* file = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> };</div>
</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>}</div>
<div class="ttc" id="aclassmce_1_1io_1_1_file_output_stream_html_afa07782fd21742c833545744a907a163"><div class="ttname"><a href="classmce_1_1io_1_1_file_output_stream.html#afa07782fd21742c833545744a907a163">mce::io::FileOutputStream::FileOutputStream</a></div><div class="ttdeci">FileOutputStream()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a339cf5f940b99e786c8573df087ec180"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a339cf5f940b99e786c8573df087ec180">mce::io::stream::FileOutputStream::INVALID_FILE_SIZE</a></div><div class="ttdeci">static constexpr size_t INVALID_FILE_SIZE</div><div class="ttdoc">Constant indicating an invalid file size/position.</div><div class="ttdef"><b>Definition</b> FileOutputStream.hpp:76</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a579d72d46213ac70df80d73e98a7beec"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a579d72d46213ac70df80d73e98a7beec">mce::io::stream::FileOutputStream::write</a></div><div class="ttdeci">size_t write(const void *buffer, size_t size) override</div><div class="ttdoc">Write bytes to the file.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a6eeb71a3396de98cbf0a6ae9acd43f81"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a6eeb71a3396de98cbf0a6ae9acd43f81">mce::io::stream::FileOutputStream::seek</a></div><div class="ttdeci">size_t seek(size_t position) override</div><div class="ttdoc">Change the current write position in the file.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a7452adddb31d4282113a11418cdf26c9"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a7452adddb31d4282113a11418cdf26c9">mce::io::stream::FileOutputStream::INVALID_FILE_POSITION</a></div><div class="ttdeci">static constexpr size_t INVALID_FILE_POSITION</div><div class="ttdoc">Constant indicating an invalid file position.</div><div class="ttdef"><b>Definition</b> FileOutputStream.hpp:81</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a8d5e97b01178866c7d898d06872b8223"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a8d5e97b01178866c7d898d06872b8223">mce::io::stream::FileOutputStream::getSize</a></div><div class="ttdeci">size_t getSize() override</div><div class="ttdoc">Get the total size of the underlying file in bytes.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_a957bc7e779b3967f65d45ab6d7a81ce8"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#a957bc7e779b3967f65d45ab6d7a81ce8">mce::io::stream::FileOutputStream::close</a></div><div class="ttdeci">void close()</div><div class="ttdoc">Close the file and release any resources.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_aa5850054846c0e24e244ec8f137f80c8"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#aa5850054846c0e24e244ec8f137f80c8">mce::io::stream::FileOutputStream::isOpen</a></div><div class="ttdeci">bool isOpen() const</div><div class="ttdoc">Query whether the underlying file handle is open.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_afa07782fd21742c833545744a907a163"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afa07782fd21742c833545744a907a163">mce::io::stream::FileOutputStream::FileOutputStream</a></div><div class="ttdeci">FileOutputStream()=default</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_afd682afed600aa9f2efda8965c5c5bf1"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afd682afed600aa9f2efda8965c5c5bf1">mce::io::stream::FileOutputStream::open</a></div><div class="ttdeci">bool open(const std::string &amp;file)</div><div class="ttdoc">Opens a file for writing (creates/truncates by default).</div></div>
<div class="ttc" id="aclassmce_1_1io_1_1stream_1_1_file_output_stream_html_afe6e6ec5cf6a1396faa94130cce9cf43"><div class="ttname"><a href="classmce_1_1io_1_1stream_1_1_file_output_stream.html#afe6e6ec5cf6a1396faa94130cce9cf43">mce::io::stream::FileOutputStream::tell</a></div><div class="ttdeci">size_t tell() override</div><div class="ttdoc">Get the current write position in the file.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>Minecraft-Community-Edition</b></li><li class="navelem"><b>IO</b></li><li class="navelem"><b>Stream</b></li><li class="navelem"><b>FileOutputStream.hpp</b></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