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

374 lines
18 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::FileOutputStream 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_output_stream.html','','classmce_1_1_file_output_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::FileOutputStream Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Platform-independent file output stream implementation.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_file_output_stream_8hpp_source.html">FileOutputStream.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mce::FileOutputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classmce_1_1_file_output_stream.png" usemap="#mce_3A_3AFileOutputStream_map" alt=""/>
<map id="mce_3A_3AFileOutputStream_map" name="mce_3A_3AFileOutputStream_map">
<area href="classmce_1_1_output_stream.html" alt="mce::OutputStream" shape="rect" coords="0,0,138,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:a0ab5f8d7e010b94a072bc13b52e5dd1c" id="r_a0ab5f8d7e010b94a072bc13b52e5dd1c"><td class="memItemLeft"><a id="a0ab5f8d7e010b94a072bc13b52e5dd1c" name="a0ab5f8d7e010b94a072bc13b52e5dd1c"></a>
&#160;</td><td class="memItemRight"><b>FileOutputStream</b> ()=default</td></tr>
<tr class="memdesc:a0ab5f8d7e010b94a072bc13b52e5dd1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="memitem:acc1a4e675eba02a8dad17a6acd1d4265" id="r_acc1a4e675eba02a8dad17a6acd1d4265"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#acc1a4e675eba02a8dad17a6acd1d4265">open</a> (const std::string &amp;file)</td></tr>
<tr class="memdesc:acc1a4e675eba02a8dad17a6acd1d4265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a file for writing (creates/truncates by default). <br /></td></tr>
<tr class="memitem:ae17a2bca1876c50cb5725b41551dd43b" id="r_ae17a2bca1876c50cb5725b41551dd43b"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#ae17a2bca1876c50cb5725b41551dd43b">isOpen</a> () const</td></tr>
<tr class="memdesc:ae17a2bca1876c50cb5725b41551dd43b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query whether the underlying file handle is open. <br /></td></tr>
<tr class="memitem:a695bf4b8e186fcd40a666487e4e4b8f1" id="r_a695bf4b8e186fcd40a666487e4e4b8f1"><td class="memItemLeft"><a id="a695bf4b8e186fcd40a666487e4e4b8f1" name="a695bf4b8e186fcd40a666487e4e4b8f1"></a>
void&#160;</td><td class="memItemRight"><b>close</b> ()</td></tr>
<tr class="memdesc:a695bf4b8e186fcd40a666487e4e4b8f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the file and release any resources. <br /></td></tr>
<tr class="memitem:ac6e82fc9655a7a1dfd3d981519f18583" id="r_ac6e82fc9655a7a1dfd3d981519f18583"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#ac6e82fc9655a7a1dfd3d981519f18583">write</a> (const void *buffer, size_t size) override</td></tr>
<tr class="memdesc:ac6e82fc9655a7a1dfd3d981519f18583"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write bytes to the file. <br /></td></tr>
<tr class="memitem:aa198c5d7ebede14fa06d0de7a05a2028" id="r_aa198c5d7ebede14fa06d0de7a05a2028"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#aa198c5d7ebede14fa06d0de7a05a2028">seek</a> (size_t position) override</td></tr>
<tr class="memdesc:aa198c5d7ebede14fa06d0de7a05a2028"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the current write position in the file. <br /></td></tr>
<tr class="memitem:aa6659c362021935717bbfc176075877a" id="r_aa6659c362021935717bbfc176075877a"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#aa6659c362021935717bbfc176075877a">tell</a> () override</td></tr>
<tr class="memdesc:aa6659c362021935717bbfc176075877a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current write position in the file. <br /></td></tr>
<tr class="memitem:a4160ad51b9d0d867e45bba2a3a4d30db" id="r_a4160ad51b9d0d867e45bba2a3a4d30db"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#a4160ad51b9d0d867e45bba2a3a4d30db">getSize</a> () override</td></tr>
<tr class="memdesc:a4160ad51b9d0d867e45bba2a3a4d30db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the total size of the underlying file in bytes. <br /></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:a107dc72b1bc3c42eba3700f7b8533012" id="r_a107dc72b1bc3c42eba3700f7b8533012"><td class="memItemLeft">static constexpr size_t&#160;</td><td class="memItemRight"><a class="el" href="#a107dc72b1bc3c42eba3700f7b8533012">INVALID_FILE_SIZE</a> = ~(0)</td></tr>
<tr class="memdesc:a107dc72b1bc3c42eba3700f7b8533012"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant indicating an invalid file size/position. <br /></td></tr>
<tr class="memitem:a9f7a39df922d54da6c8cfaa279efa5e3" id="r_a9f7a39df922d54da6c8cfaa279efa5e3"><td class="memItemLeft"><a id="a9f7a39df922d54da6c8cfaa279efa5e3" name="a9f7a39df922d54da6c8cfaa279efa5e3"></a>
static constexpr size_t&#160;</td><td class="memItemRight"><b>INVALID_FILE_POSITION</b> = ~(0)</td></tr>
<tr class="memdesc:a9f7a39df922d54da6c8cfaa279efa5e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant indicating an invalid file position. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Platform-independent file output stream implementation. </p>
<p>Provides a concrete <a class="el" href="classmce_1_1_output_stream.html">OutputStream</a> that writes data to a file using the platform native file handle or FILE* depending on the platform. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a4160ad51b9d0d867e45bba2a3a4d30db" name="a4160ad51b9d0d867e45bba2a3a4d30db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4160ad51b9d0d867e45bba2a3a4d30db">&#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::FileOutputStream::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">
<p>Get the total size of the underlying file in bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>File size in bytes or INVALID_FILE_SIZE on error. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_output_stream.html#a4b19dae8e434c51a7d79058994c035c7">mce::OutputStream</a>.</p>
</div>
</div>
<a id="ae17a2bca1876c50cb5725b41551dd43b" name="ae17a2bca1876c50cb5725b41551dd43b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae17a2bca1876c50cb5725b41551dd43b">&#9670;&#160;</a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mce::FileOutputStream::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">
<p>Query whether the underlying file handle is open. </p>
<dl class="section return"><dt>Returns</dt><dd>True when the file is open and ready for writing. </dd></dl>
</div>
</div>
<a id="acc1a4e675eba02a8dad17a6acd1d4265" name="acc1a4e675eba02a8dad17a6acd1d4265"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc1a4e675eba02a8dad17a6acd1d4265">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mce::FileOutputStream::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>Opens a file for writing (creates/truncates by default). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>Path (absolute or relative) to the file to open. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the file was successfully opened. </dd></dl>
</div>
</div>
<a id="aa198c5d7ebede14fa06d0de7a05a2028" name="aa198c5d7ebede14fa06d0de7a05a2028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa198c5d7ebede14fa06d0de7a05a2028">&#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::FileOutputStream::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>Change the current write position in the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The absolute position (in bytes) to seek to. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new position in the file after seeking. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_output_stream.html#af2b439b646d1c6262fa2fb5e5025c0f4">mce::OutputStream</a>.</p>
</div>
</div>
<a id="aa6659c362021935717bbfc176075877a" name="aa6659c362021935717bbfc176075877a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6659c362021935717bbfc176075877a">&#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::FileOutputStream::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">
<p>Get the current write position in the file. </p>
<dl class="section return"><dt>Returns</dt><dd>Current position in bytes from the start of the file. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_output_stream.html#a738833d8f02a3442f2cd317bd64bb0c4">mce::OutputStream</a>.</p>
</div>
</div>
<a id="ac6e82fc9655a7a1dfd3d981519f18583" name="ac6e82fc9655a7a1dfd3d981519f18583"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6e82fc9655a7a1dfd3d981519f18583">&#9670;&#160;</a></span>write()</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::FileOutputStream::write </td>
<td>(</td>
<td class="paramtype">const 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>Write bytes to the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>Pointer to the data to write. </td></tr>
<tr><td class="paramname">size</td><td>Number of bytes to write from buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes actually written. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_output_stream.html#a549f1ca23e39341f9a3cc23927644d81">mce::OutputStream</a>.</p>
</div>
</div>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="a107dc72b1bc3c42eba3700f7b8533012" name="a107dc72b1bc3c42eba3700f7b8533012"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a107dc72b1bc3c42eba3700f7b8533012">&#9670;&#160;</a></span>INVALID_FILE_SIZE</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::FileOutputStream::INVALID_FILE_SIZE = ~(0)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span><span class="mlabel constexpr">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constant indicating an invalid file size/position. </p>
<p>This value is returned by <a class="el" href="#a4160ad51b9d0d867e45bba2a3a4d30db" title="Get the total size of the underlying file in bytes.">getSize()</a> or <a class="el" href="#aa6659c362021935717bbfc176075877a" title="Get the current write position in the file.">tell()</a> when the operation fails. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>IO/Stream/<a class="el" href="_file_output_stream_8hpp_source.html">FileOutputStream.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_output_stream.html">FileOutputStream</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