joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/classsf_1_1FileInputStream....

561 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsf_1_1FileInputStream-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::FileInputStream Class Reference<div class="ingroups"><a class="el" href="group__system.html">System module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Implementation of input stream based on a file.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="FileInputStream_8hpp_source.html">SFML/System/FileInputStream.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sf::FileInputStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classsf_1_1FileInputStream.png" usemap="#sf::FileInputStream_map" alt=""/>
<map id="sf::FileInputStream_map" name="sf::FileInputStream_map">
<area href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams." alt="sf::InputStream" shape="rect" coords="0,0,115,24"/>
</map>
</div></div>
<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:a9a321e273f41ff7f187899061fcae9be" id="r_a9a321e273f41ff7f187899061fcae9be"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a321e273f41ff7f187899061fcae9be">FileInputStream</a> ()</td></tr>
<tr class="memdesc:a9a321e273f41ff7f187899061fcae9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a9a321e273f41ff7f187899061fcae9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad48c7557b9a259d30aa4a1bf3dede9b7" id="r_ad48c7557b9a259d30aa4a1bf3dede9b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad48c7557b9a259d30aa4a1bf3dede9b7">~FileInputStream</a> () override</td></tr>
<tr class="memdesc:ad48c7557b9a259d30aa4a1bf3dede9b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:ad48c7557b9a259d30aa4a1bf3dede9b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a775cbc26c73b22e3a4d4528d96948467" id="r_a775cbc26c73b22e3a4d4528d96948467"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a775cbc26c73b22e3a4d4528d96948467">FileInputStream</a> (const <a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;)=delete</td></tr>
<tr class="memdesc:a775cbc26c73b22e3a4d4528d96948467"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy constructor. <br /></td></tr>
<tr class="separator:a775cbc26c73b22e3a4d4528d96948467"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfd055fb4070ca4a19587f9ce2b19cfc" id="r_adfd055fb4070ca4a19587f9ce2b19cfc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfd055fb4070ca4a19587f9ce2b19cfc">operator=</a> (const <a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;)=delete</td></tr>
<tr class="memdesc:adfd055fb4070ca4a19587f9ce2b19cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy assignment. <br /></td></tr>
<tr class="separator:adfd055fb4070ca4a19587f9ce2b19cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeaeb1abfa0dd040a5b4781b0ec2bdb1" id="r_aaeaeb1abfa0dd040a5b4781b0ec2bdb1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaeaeb1abfa0dd040a5b4781b0ec2bdb1">FileInputStream</a> (<a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&amp;) noexcept</td></tr>
<tr class="memdesc:aaeaeb1abfa0dd040a5b4781b0ec2bdb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:aaeaeb1abfa0dd040a5b4781b0ec2bdb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c60301457920167477aa32a0e6b35a8" id="r_a6c60301457920167477aa32a0e6b35a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c60301457920167477aa32a0e6b35a8">operator=</a> (<a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&amp;) noexcept</td></tr>
<tr class="memdesc:a6c60301457920167477aa32a0e6b35a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <br /></td></tr>
<tr class="separator:a6c60301457920167477aa32a0e6b35a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bc37e902c60db7c309d2b9adca31861" id="r_a0bc37e902c60db7c309d2b9adca31861"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bc37e902c60db7c309d2b9adca31861">FileInputStream</a> (const std::filesystem::path &amp;filename)</td></tr>
<tr class="memdesc:a0bc37e902c60db7c309d2b9adca31861"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the stream from a file path. <br /></td></tr>
<tr class="separator:a0bc37e902c60db7c309d2b9adca31861"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a62ca25f1e487ce77dc5180e60e33e" id="r_ab3a62ca25f1e487ce77dc5180e60e33e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab3a62ca25f1e487ce77dc5180e60e33e">open</a> (const std::filesystem::path &amp;filename)</td></tr>
<tr class="memdesc:ab3a62ca25f1e487ce77dc5180e60e33e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the stream from a file path. <br /></td></tr>
<tr class="separator:ab3a62ca25f1e487ce77dc5180e60e33e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a179a69a4b7acdd19000af0e32601fdca" id="r_a179a69a4b7acdd19000af0e32601fdca"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a179a69a4b7acdd19000af0e32601fdca">read</a> (void *data, std::size_t size) override</td></tr>
<tr class="memdesc:a179a69a4b7acdd19000af0e32601fdca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read data from the stream. <br /></td></tr>
<tr class="separator:a179a69a4b7acdd19000af0e32601fdca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e989548005120c4a3d0ae05d3efa671" id="r_a3e989548005120c4a3d0ae05d3efa671"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e989548005120c4a3d0ae05d3efa671">seek</a> (std::size_t position) override</td></tr>
<tr class="memdesc:a3e989548005120c4a3d0ae05d3efa671"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the current reading position. <br /></td></tr>
<tr class="separator:a3e989548005120c4a3d0ae05d3efa671"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61deec14469a0f0c568147a95d5f387c" id="r_a61deec14469a0f0c568147a95d5f387c"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a61deec14469a0f0c568147a95d5f387c">tell</a> () override</td></tr>
<tr class="memdesc:a61deec14469a0f0c568147a95d5f387c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current reading position in the stream. <br /></td></tr>
<tr class="separator:a61deec14469a0f0c568147a95d5f387c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d3e4a80753bb4dad741e90cc67df9a1" id="r_a0d3e4a80753bb4dad741e90cc67df9a1"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d3e4a80753bb4dad741e90cc67df9a1">getSize</a> () override</td></tr>
<tr class="memdesc:a0d3e4a80753bb4dad741e90cc67df9a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the size of the stream. <br /></td></tr>
<tr class="separator:a0d3e4a80753bb4dad741e90cc67df9a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of input stream based on a file. </p>
<p>This class is a specialization of <code><a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">InputStream</a></code> that reads from a file on disk.</p>
<p>It wraps a file in the common <code><a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">InputStream</a></code> interface and therefore allows to use generic classes or functions that accept such a stream, with a file on disk as the data source.</p>
<p>In addition to the virtual functions inherited from <code><a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">InputStream</a></code>, <code><a class="el" href="classsf_1_1FileInputStream.html" title="Implementation of input stream based on a file.">FileInputStream</a></code> adds a function to specify the file to open.</p>
<p>SFML resource classes can usually be loaded directly from a filename, so this class shouldn't be useful to you unless you create your own algorithms that operate on an <a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">InputStream</a>.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> process(<a class="code hl_class" href="classsf_1_1InputStream.html">InputStream</a>&amp; stream);</div>
<div class="line"> </div>
<div class="line">std::optional stream = <a class="code hl_function" href="#ab3a62ca25f1e487ce77dc5180e60e33e">sf::FileInputStream::open</a>(<span class="stringliteral">&quot;some_file.dat&quot;</span>);</div>
<div class="line"><span class="keywordflow">if</span> (stream)</div>
<div class="line"> process(*stream);</div>
<div class="ttc" id="aclasssf_1_1FileInputStream_html_ab3a62ca25f1e487ce77dc5180e60e33e"><div class="ttname"><a href="#ab3a62ca25f1e487ce77dc5180e60e33e">sf::FileInputStream::open</a></div><div class="ttdeci">bool open(const std::filesystem::path &amp;filename)</div><div class="ttdoc">Open the stream from a file path.</div></div>
<div class="ttc" id="aclasssf_1_1InputStream_html"><div class="ttname"><a href="classsf_1_1InputStream.html">sf::InputStream</a></div><div class="ttdoc">Abstract class for custom file input streams.</div><div class="ttdef"><b>Definition</b> <a href="InputStream_8hpp_source.html#l00045">InputStream.hpp:46</a></div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1InputStream.html" title="Abstract class for custom file input streams.">InputStream</a></code>, <code><a class="el" href="classsf_1_1MemoryInputStream.html" title="Implementation of input stream based on a memory chunk.">MemoryInputStream</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="FileInputStream_8hpp_source.html#l00056">56</a> of file <a class="el" href="FileInputStream_8hpp_source.html">FileInputStream.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9a321e273f41ff7f187899061fcae9be" name="a9a321e273f41ff7f187899061fcae9be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a321e273f41ff7f187899061fcae9be">&#9670;&#160;</a></span>FileInputStream() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::FileInputStream::FileInputStream </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Construct a file input stream that is not associated with a file to read. </p>
</div>
</div>
<a id="ad48c7557b9a259d30aa4a1bf3dede9b7" name="ad48c7557b9a259d30aa4a1bf3dede9b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad48c7557b9a259d30aa4a1bf3dede9b7">&#9670;&#160;</a></span>~FileInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::FileInputStream::~FileInputStream </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</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
</div>
</div>
<a id="a775cbc26c73b22e3a4d4528d96948467" name="a775cbc26c73b22e3a4d4528d96948467"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a775cbc26c73b22e3a4d4528d96948467">&#9670;&#160;</a></span>FileInputStream() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::FileInputStream::FileInputStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy constructor. </p>
</div>
</div>
<a id="aaeaeb1abfa0dd040a5b4781b0ec2bdb1" name="aaeaeb1abfa0dd040a5b4781b0ec2bdb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeaeb1abfa0dd040a5b4781b0ec2bdb1">&#9670;&#160;</a></span>FileInputStream() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::FileInputStream::FileInputStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&amp;</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
</div>
</div>
<a id="a0bc37e902c60db7c309d2b9adca31861" name="a0bc37e902c60db7c309d2b9adca31861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bc37e902c60db7c309d2b9adca31861">&#9670;&#160;</a></span>FileInputStream() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::FileInputStream::FileInputStream </td>
<td>(</td>
<td class="paramtype">const std::filesystem::path &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the stream from a file path. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of the file to open</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classsf_1_1Exception.html" title="Library-specific exception type.">sf::Exception</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0d3e4a80753bb4dad741e90cc67df9a1" name="a0d3e4a80753bb4dad741e90cc67df9a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d3e4a80753bb4dad741e90cc67df9a1">&#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">std::optional&lt; std::size_t &gt; sf::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</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size of the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The total number of bytes available in the stream, or <code>std::nullopt</code> on error </dd></dl>
<p>Implements <a class="el" href="classsf_1_1InputStream.html#a2d735fa531dd65747f743b09331ea7c8">sf::InputStream</a>.</p>
</div>
</div>
<a id="ab3a62ca25f1e487ce77dc5180e60e33e" name="ab3a62ca25f1e487ce77dc5180e60e33e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3a62ca25f1e487ce77dc5180e60e33e">&#9670;&#160;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::FileInputStream::open </td>
<td>(</td>
<td class="paramtype">const std::filesystem::path &amp;</td> <td class="paramname"><span class="paramname"><em>filename</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the stream from a file path. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of the file to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> on error </dd></dl>
</div>
</div>
<a id="adfd055fb4070ca4a19587f9ce2b19cfc" name="adfd055fb4070ca4a19587f9ce2b19cfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfd055fb4070ca4a19587f9ce2b19cfc">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp; sf::FileInputStream::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy assignment. </p>
</div>
</div>
<a id="a6c60301457920167477aa32a0e6b35a8" name="a6c60301457920167477aa32a0e6b35a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c60301457920167477aa32a0e6b35a8">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp; sf::FileInputStream::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1FileInputStream.html">FileInputStream</a> &amp;&amp;</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
</div>
</div>
<a id="a179a69a4b7acdd19000af0e32601fdca" name="a179a69a4b7acdd19000af0e32601fdca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a179a69a4b7acdd19000af0e32601fdca">&#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">std::optional&lt; std::size_t &gt; sf::FileInputStream::read </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::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">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from the stream. </p>
<p>After reading, the stream's reading position must be advanced by the amount of bytes read.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Buffer where to copy the read data </td></tr>
<tr><td class="paramname">size</td><td>Desired number of bytes to read</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes actually read, or <code>std::nullopt</code> on error </dd></dl>
<p>Implements <a class="el" href="classsf_1_1InputStream.html#a966518d3a4cba44ae5c28847865c487d">sf::InputStream</a>.</p>
</div>
</div>
<a id="a3e989548005120c4a3d0ae05d3efa671" name="a3e989548005120c4a3d0ae05d3efa671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e989548005120c4a3d0ae05d3efa671">&#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">std::optional&lt; std::size_t &gt; sf::FileInputStream::seek </td>
<td>(</td>
<td class="paramtype">std::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">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the current reading position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The position to seek to, from the beginning</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The position actually sought to, or <code>std::nullopt</code> on error </dd></dl>
<p>Implements <a class="el" href="classsf_1_1InputStream.html#ab53feb45aa824cc2117362ab79b38352">sf::InputStream</a>.</p>
</div>
</div>
<a id="a61deec14469a0f0c568147a95d5f387c" name="a61deec14469a0f0c568147a95d5f387c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61deec14469a0f0c568147a95d5f387c">&#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">std::optional&lt; std::size_t &gt; sf::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">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current reading position in the stream. </p>
<dl class="section return"><dt>Returns</dt><dd>The current position, or <code>std::nullopt</code> on error. </dd></dl>
<p>Implements <a class="el" href="classsf_1_1InputStream.html#a03ec284866fd46ef2a3673e022f89895">sf::InputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FileInputStream_8hpp_source.html">FileInputStream.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink