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

352 lines
17 KiB
HTML
Raw 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::MemoryInputStream 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_memory_input_stream.html','','classmce_1_1_memory_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::MemoryInputStream Class Reference<span class="mlabels"><span class="mlabel final">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Memory-backed input stream.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_memory_input_stream_8hpp_source.html">MemoryInputStream.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mce::MemoryInputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classmce_1_1_memory_input_stream.png" usemap="#mce_3A_3AMemoryInputStream_map" alt=""/>
<map id="mce_3A_3AMemoryInputStream_map" name="mce_3A_3AMemoryInputStream_map">
<area href="classmce_1_1_input_stream.html" alt="mce::InputStream" shape="rect" coords="0,0,153,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:a6f8edd8bbe3b0fe735cce8f43f2a41b4" id="r_a6f8edd8bbe3b0fe735cce8f43f2a41b4"><td class="memItemLeft">&#160;</td><td class="memItemRight"><a class="el" href="#a6f8edd8bbe3b0fe735cce8f43f2a41b4">MemoryInputStream</a> (const void *data, size_t size)</td></tr>
<tr class="memdesc:a6f8edd8bbe3b0fe735cce8f43f2a41b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a memory input stream over existing data. <br /></td></tr>
<tr class="memitem:a11da8b6c2f59d0a5987bf06b93245bb1" id="r_a11da8b6c2f59d0a5987bf06b93245bb1"><td class="memItemLeft">virtual size_t&#160;</td><td class="memItemRight"><a class="el" href="#a11da8b6c2f59d0a5987bf06b93245bb1">read</a> (void *buffer, size_t size) override</td></tr>
<tr class="memdesc:a11da8b6c2f59d0a5987bf06b93245bb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read bytes from the memory buffer into the provided buffer. <br /></td></tr>
<tr class="memitem:ac3771e7c4a9f8bb4a6e10581683fb97b" id="r_ac3771e7c4a9f8bb4a6e10581683fb97b"><td class="memItemLeft">size_t&#160;</td><td class="memItemRight"><a class="el" href="#ac3771e7c4a9f8bb4a6e10581683fb97b">readString</a> (char *&amp;buffer, size_t &amp;size)</td></tr>
<tr class="memdesc:ac3771e7c4a9f8bb4a6e10581683fb97b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a NUL-terminated string from the stream. <br /></td></tr>
<tr class="memitem:a30df68220fde1b86deee930444e729d1" id="r_a30df68220fde1b86deee930444e729d1"><td class="memItemLeft">virtual size_t&#160;</td><td class="memItemRight"><a class="el" href="#a30df68220fde1b86deee930444e729d1">seek</a> (size_t position) override</td></tr>
<tr class="memdesc:a30df68220fde1b86deee930444e729d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seek to an absolute position in the memory buffer. <br /></td></tr>
<tr class="memitem:a229ade412a4c8843a77d68b5a99814c0" id="r_a229ade412a4c8843a77d68b5a99814c0"><td class="memItemLeft">virtual size_t&#160;</td><td class="memItemRight"><a class="el" href="#a229ade412a4c8843a77d68b5a99814c0">tell</a> () override</td></tr>
<tr class="memdesc:a229ade412a4c8843a77d68b5a99814c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current read position in the buffer. <br /></td></tr>
<tr class="memitem:a220e82b4a2096923f91b02058a354c1a" id="r_a220e82b4a2096923f91b02058a354c1a"><td class="memItemLeft">virtual size_t&#160;</td><td class="memItemRight"><a class="el" href="#a220e82b4a2096923f91b02058a354c1a">getSize</a> () override</td></tr>
<tr class="memdesc:a220e82b4a2096923f91b02058a354c1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the total size of the memory buffer. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Memory-backed input stream. </p>
<p>Provides a read-only <a class="el" href="classmce_1_1_input_stream.html">InputStream</a> view over an existing memory buffer. The stream does not take ownership of the provided memory; the caller is responsible for ensuring the lifetime of the memory buffer exceeds the lifetime of the <a class="el" href="classmce_1_1_memory_input_stream.html" title="Memory-backed input stream.">MemoryInputStream</a> instance. </p>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a6f8edd8bbe3b0fe735cce8f43f2a41b4" name="a6f8edd8bbe3b0fe735cce8f43f2a41b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f8edd8bbe3b0fe735cce8f43f2a41b4">&#9670;&#160;</a></span>MemoryInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mce::MemoryInputStream::MemoryInputStream </td>
<td>(</td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</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>
</div><div class="memdoc">
<p>Construct a memory input stream over existing data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Pointer to the memory buffer to read from. Must not be nullptr unless size is zero. </td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</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="a220e82b4a2096923f91b02058a354c1a" name="a220e82b4a2096923f91b02058a354c1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a220e82b4a2096923f91b02058a354c1a">&#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::MemoryInputStream::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 memory buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>Size of the buffer 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="a11da8b6c2f59d0a5987bf06b93245bb1" name="a11da8b6c2f59d0a5987bf06b93245bb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11da8b6c2f59d0a5987bf06b93245bb1">&#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::MemoryInputStream::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>Read bytes from the memory buffer into the provided buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>Destination buffer to receive data. </td></tr>
<tr><td class="paramname">size</td><td>Maximum number of bytes to read from the stream. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes actually read. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a548e3aeadfb9222019bcb59a39848d9e">mce::InputStream</a>.</p>
</div>
</div>
<a id="ac3771e7c4a9f8bb4a6e10581683fb97b" name="ac3771e7c4a9f8bb4a6e10581683fb97b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3771e7c4a9f8bb4a6e10581683fb97b">&#9670;&#160;</a></span>readString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mce::MemoryInputStream::readString </td>
<td>(</td>
<td class="paramtype">char *&amp;</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 &amp;</td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a NUL-terminated string from the stream. </p>
<p>The function does not allocate new memory for the string. Instead it returns a pointer into the original memory buffer via the buffer reference parameter. The returned pointer is valid only while the original memory and this stream remain valid.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>Reference to a char* which will be set to point to the string inside the memory buffer. </td></tr>
<tr><td class="paramname">size</td><td>Reference to a size_t which will be set to the length of the string (excluding the terminating NUL). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes consumed from the stream, including the terminating NULL byte. </dd></dl>
</div>
</div>
<a id="a30df68220fde1b86deee930444e729d1" name="a30df68220fde1b86deee930444e729d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30df68220fde1b86deee930444e729d1">&#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::MemoryInputStream::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>Seek to an absolute position in the memory buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>Absolute position in bytes from the start of the buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new position after seeking. </dd></dl>
<p>Implements <a class="el" href="classmce_1_1_input_stream.html#a4c7ee56f44922aa52b608d44cbc4235c">mce::InputStream</a>.</p>
</div>
</div>
<a id="a229ade412a4c8843a77d68b5a99814c0" name="a229ade412a4c8843a77d68b5a99814c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a229ade412a4c8843a77d68b5a99814c0">&#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::MemoryInputStream::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 read position in the buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>Current position in bytes from the start of the buffer. </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 files:<ul>
<li>IO/Stream/<a class="el" href="_memory_input_stream_8hpp_source.html">MemoryInputStream.hpp</a></li>
<li>IO/Stream/<b>MemoryInputStream.cpp</b></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_memory_input_stream.html">MemoryInputStream</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