494 lines
42 KiB
HTML
494 lines
42 KiB
HTML
|
<!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">
|
||
|
|
<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.9.4"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>DNA Calib: trio::FileStream Class Reference</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>
|
||
|
|
<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">DNA Calib<span id="projectnumber"> 1.1</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">Project brief</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
<!-- 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">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="namespacetrio.html">trio</a></li><li class="navelem"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="classtrio_1_1FileStream-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">trio::FileStream Class Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Standard file stream.
|
||
|
|
<a href="classtrio_1_1FileStream.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="FileStream_8h_source.html">FileStream.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for trio::FileStream:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classtrio_1_1FileStream__inherit__graph.png" border="0" usemap="#atrio_1_1FileStream_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="atrio_1_1FileStream_inherit__map" id="atrio_1_1FileStream_inherit__map">
|
||
|
|
<area shape="rect" title="Standard file stream." alt="" coords="323,484,437,664"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1FileStreamImpl.html" title=" " alt="" coords="299,712,461,1024"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1BoundedIOStream.html" title=" " alt="" coords="302,300,458,436"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Controllable.html" title=" " alt="" coords="63,160,180,237"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Openable.html" title=" " alt="" coords="5,5,109,97"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Closeable.html" title=" " alt="" coords="133,5,240,97"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Readable.html" title=" " alt="" coords="205,145,307,252"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Writable.html" title=" " alt="" coords="331,145,429,252"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Seekable.html" title=" " alt="" coords="453,145,555,252"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Bounded.html" title=" " alt="" coords="579,153,679,245"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for trio::FileStream:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classtrio_1_1FileStream__coll__graph.png" border="0" usemap="#atrio_1_1FileStream_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="atrio_1_1FileStream_coll__map" id="atrio_1_1FileStream_coll__map">
|
||
|
|
<area shape="rect" title="Standard file stream." alt="" coords="385,501,498,681"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1BoundedIOStream.html" title=" " alt="" coords="363,375,519,452"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Controllable.html" title=" " alt="" coords="63,161,180,239"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Openable.html" title=" " alt="" coords="5,5,109,97"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Closeable.html" title=" " alt="" coords="133,5,240,97"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Readable.html" title=" " alt="" coords="205,147,307,253"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Writable.html" title=" " alt="" coords="331,147,429,253"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Seekable.html" title=" " alt="" coords="453,147,555,253"/>
|
||
|
|
<area shape="rect" href="classtrio_1_1Bounded.html" title=" " alt="" coords="579,154,679,246"/>
|
||
|
|
<area shape="rect" href="structsc_1_1StatusCode.html" title=" " alt="" coords="704,154,816,246"/>
|
||
|
|
</map>
|
||
|
|
</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:a75e6821531456b6f0238abb2d987a640"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a75e6821531456b6f0238abb2d987a640">FileStream</a> ()=default</td></tr>
|
||
|
|
<tr class="separator:a75e6821531456b6f0238abb2d987a640"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a65809a260adc501a052a7d7476ad1553"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a65809a260adc501a052a7d7476ad1553">~FileStream</a> () override</td></tr>
|
||
|
|
<tr class="separator:a65809a260adc501a052a7d7476ad1553"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a1d1c14f8be2b90aa32ad07a7605505a4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a1d1c14f8be2b90aa32ad07a7605505a4">FileStream</a> (const <a class="el" href="classtrio_1_1FileStream.html">FileStream</a> &)=delete</td></tr>
|
||
|
|
<tr class="separator:a1d1c14f8be2b90aa32ad07a7605505a4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7f1699314e2e469ae78a1a2b5a635cb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a7f1699314e2e469ae78a1a2b5a635cb5">operator=</a> (const <a class="el" href="classtrio_1_1FileStream.html">FileStream</a> &)=delete</td></tr>
|
||
|
|
<tr class="separator:a7f1699314e2e469ae78a1a2b5a635cb5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6eea6f8958a7554ec6c0b122b7786abe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a6eea6f8958a7554ec6c0b122b7786abe">FileStream</a> (<a class="el" href="classtrio_1_1FileStream.html">FileStream</a> &&)=default</td></tr>
|
||
|
|
<tr class="separator:a6eea6f8958a7554ec6c0b122b7786abe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a897e527409bd3a3ae8e7ef4a7dc3e5d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a897e527409bd3a3ae8e7ef4a7dc3e5d2">operator=</a> (<a class="el" href="classtrio_1_1FileStream.html">FileStream</a> &&)=default</td></tr>
|
||
|
|
<tr class="separator:a897e527409bd3a3ae8e7ef4a7dc3e5d2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1BoundedIOStream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1BoundedIOStream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1BoundedIOStream.html">trio::BoundedIOStream</a></td></tr>
|
||
|
|
<tr class="memitem:a68637af962300a39b1048d53d50d1f7c inherit pub_methods_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#a68637af962300a39b1048d53d50d1f7c">~BoundedIOStream</a> ()</td></tr>
|
||
|
|
<tr class="separator:a68637af962300a39b1048d53d50d1f7c inherit pub_methods_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Openable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Openable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Openable.html">trio::Openable</a></td></tr>
|
||
|
|
<tr class="memitem:addfdc5360983a446fe200410a3eaef8f inherit pub_methods_classtrio_1_1Openable"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">open</a> ()=0</td></tr>
|
||
|
|
<tr class="memdesc:addfdc5360983a446fe200410a3eaef8f inherit pub_methods_classtrio_1_1Openable"><td class="mdescLeft"> </td><td class="mdescRight">Open access to the stream. <a href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:addfdc5360983a446fe200410a3eaef8f inherit pub_methods_classtrio_1_1Openable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Closeable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Closeable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Closeable.html">trio::Closeable</a></td></tr>
|
||
|
|
<tr class="memitem:ac2e99d3bd99a39cf528ba29b1ba0baf1 inherit pub_methods_classtrio_1_1Closeable"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Closeable.html#ac2e99d3bd99a39cf528ba29b1ba0baf1">close</a> ()=0</td></tr>
|
||
|
|
<tr class="memdesc:ac2e99d3bd99a39cf528ba29b1ba0baf1 inherit pub_methods_classtrio_1_1Closeable"><td class="mdescLeft"> </td><td class="mdescRight">Close access to the stream. <a href="classtrio_1_1Closeable.html#ac2e99d3bd99a39cf528ba29b1ba0baf1">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ac2e99d3bd99a39cf528ba29b1ba0baf1 inherit pub_methods_classtrio_1_1Closeable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Readable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Readable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Readable.html">trio::Readable</a></td></tr>
|
||
|
|
<tr class="memitem:a134ad61b17c812f7aa2d912fc96d36f9 inherit pub_methods_classtrio_1_1Readable"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Readable.html#a134ad61b17c812f7aa2d912fc96d36f9">read</a> (char *destination, std::size_t size)=0</td></tr>
|
||
|
|
<tr class="memdesc:a134ad61b17c812f7aa2d912fc96d36f9 inherit pub_methods_classtrio_1_1Readable"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes from stream into the given buffer. <a href="classtrio_1_1Readable.html#a134ad61b17c812f7aa2d912fc96d36f9">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a134ad61b17c812f7aa2d912fc96d36f9 inherit pub_methods_classtrio_1_1Readable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae7272a2547bb33c20c9b37493491c6c1 inherit pub_methods_classtrio_1_1Readable"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Readable.html#ae7272a2547bb33c20c9b37493491c6c1">read</a> (<a class="el" href="classtrio_1_1Writable.html">Writable</a> *destination, std::size_t size)=0</td></tr>
|
||
|
|
<tr class="memdesc:ae7272a2547bb33c20c9b37493491c6c1 inherit pub_methods_classtrio_1_1Readable"><td class="mdescLeft"> </td><td class="mdescRight">Read bytes from this stream into the given stream. <a href="classtrio_1_1Readable.html#ae7272a2547bb33c20c9b37493491c6c1">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ae7272a2547bb33c20c9b37493491c6c1 inherit pub_methods_classtrio_1_1Readable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Writable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Writable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Writable.html">trio::Writable</a></td></tr>
|
||
|
|
<tr class="memitem:a463e8d3e652fc4c3ce971d3fc2eaec7e inherit pub_methods_classtrio_1_1Writable"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#a463e8d3e652fc4c3ce971d3fc2eaec7e">write</a> (const char *source, std::size_t size)=0</td></tr>
|
||
|
|
<tr class="memdesc:a463e8d3e652fc4c3ce971d3fc2eaec7e inherit pub_methods_classtrio_1_1Writable"><td class="mdescLeft"> </td><td class="mdescRight">Writes bytes from the given buffer to the stream. <a href="classtrio_1_1Writable.html#a463e8d3e652fc4c3ce971d3fc2eaec7e">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a463e8d3e652fc4c3ce971d3fc2eaec7e inherit pub_methods_classtrio_1_1Writable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7c23fed723a8afefd8ecfd78a48d18dc inherit pub_methods_classtrio_1_1Writable"><td class="memItemLeft" align="right" valign="top">virtual std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#a7c23fed723a8afefd8ecfd78a48d18dc">write</a> (<a class="el" href="classtrio_1_1Readable.html">Readable</a> *source, std::size_t size)=0</td></tr>
|
||
|
|
<tr class="memdesc:a7c23fed723a8afefd8ecfd78a48d18dc inherit pub_methods_classtrio_1_1Writable"><td class="mdescLeft"> </td><td class="mdescRight">Writes bytes from the given stream to this stream. <a href="classtrio_1_1Writable.html#a7c23fed723a8afefd8ecfd78a48d18dc">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a7c23fed723a8afefd8ecfd78a48d18dc inherit pub_methods_classtrio_1_1Writable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Seekable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Seekable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Seekable.html">trio::Seekable</a></td></tr>
|
||
|
|
<tr class="memitem:af5071bbc6e4760fdfb3d5c0d83117b85 inherit pub_methods_classtrio_1_1Seekable"><td class="memItemLeft" align="right" valign="top">virtual std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#af5071bbc6e4760fdfb3d5c0d83117b85">tell</a> ()=0</td></tr>
|
||
|
|
<tr class="memdesc:af5071bbc6e4760fdfb3d5c0d83117b85 inherit pub_methods_classtrio_1_1Seekable"><td class="mdescLeft"> </td><td class="mdescRight">Get the current position in the stream. <a href="classtrio_1_1Seekable.html#af5071bbc6e4760fdfb3d5c0d83117b85">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af5071bbc6e4760fdfb3d5c0d83117b85 inherit pub_methods_classtrio_1_1Seekable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aea11c922f49ddf61a0f30f7ad41dde2c inherit pub_methods_classtrio_1_1Seekable"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#aea11c922f49ddf61a0f30f7ad41dde2c">seek</a> (std::uint64_t position)=0</td></tr>
|
||
|
|
<tr class="memdesc:aea11c922f49ddf61a0f30f7ad41dde2c inherit pub_methods_classtrio_1_1Seekable"><td class="mdescLeft"> </td><td class="mdescRight">Set the current position in the stream. <a href="classtrio_1_1Seekable.html#aea11c922f49ddf61a0f30f7ad41dde2c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aea11c922f49ddf61a0f30f7ad41dde2c inherit pub_methods_classtrio_1_1Seekable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_methods_classtrio_1_1Bounded"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtrio_1_1Bounded')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtrio_1_1Bounded.html">trio::Bounded</a></td></tr>
|
||
|
|
<tr class="memitem:af35254c3e5f016117885d7234c80d9a7 inherit pub_methods_classtrio_1_1Bounded"><td class="memItemLeft" align="right" valign="top">virtual std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Bounded.html#af35254c3e5f016117885d7234c80d9a7">size</a> ()=0</td></tr>
|
||
|
|
<tr class="memdesc:af35254c3e5f016117885d7234c80d9a7 inherit pub_methods_classtrio_1_1Bounded"><td class="mdescLeft"> </td><td class="mdescRight">Obtain size of stream in bytes. <a href="classtrio_1_1Bounded.html#af35254c3e5f016117885d7234c80d9a7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af35254c3e5f016117885d7234c80d9a7 inherit pub_methods_classtrio_1_1Bounded"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a0d6564c770dac2d589f9300e50d6a820"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classtrio_1_1FileStream.html">FileStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#a0d6564c770dac2d589f9300e50d6a820">create</a> (const char *path, <a class="el" href="namespacetrio.html#a4b77aebe484e434a3112e66b70acd116">AccessMode</a> accessMode, <a class="el" href="namespacetrio.html#a6020d2cf223a27e6f0c208754c379dce">OpenMode</a> openMode, <a class="el" href="classpma_1_1MemoryResource.html">MemoryResource</a> *memRes=nullptr)</td></tr>
|
||
|
|
<tr class="memdesc:a0d6564c770dac2d589f9300e50d6a820"><td class="mdescLeft"> </td><td class="mdescRight">Factory method for creation of a <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> instance. <a href="classtrio_1_1FileStream.html#a0d6564c770dac2d589f9300e50d6a820">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a0d6564c770dac2d589f9300e50d6a820"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af77548a526355e8b3d8d890dd9a18789"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1FileStream.html#af77548a526355e8b3d8d890dd9a18789">destroy</a> (<a class="el" href="classtrio_1_1FileStream.html">FileStream</a> *instance)</td></tr>
|
||
|
|
<tr class="memdesc:af77548a526355e8b3d8d890dd9a18789"><td class="mdescLeft"> </td><td class="mdescRight">Method for freeing a <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> instance. <a href="classtrio_1_1FileStream.html#af77548a526355e8b3d8d890dd9a18789">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af77548a526355e8b3d8d890dd9a18789"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
|
||
|
|
Additional Inherited Members</h2></td></tr>
|
||
|
|
<tr class="inherit_header pub_types_classtrio_1_1BoundedIOStream"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classtrio_1_1BoundedIOStream')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classtrio_1_1BoundedIOStream.html">trio::BoundedIOStream</a></td></tr>
|
||
|
|
<tr class="memitem:ab68bb604ec68fe3571cd81789039d93f inherit pub_types_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#ab68bb604ec68fe3571cd81789039d93f">AccessMode</a> = <a class="el" href="namespacetrio.html#a4b77aebe484e434a3112e66b70acd116">trio::AccessMode</a></td></tr>
|
||
|
|
<tr class="separator:ab68bb604ec68fe3571cd81789039d93f inherit pub_types_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac7def2dc131ce92fade579b73695c972 inherit pub_types_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#ac7def2dc131ce92fade579b73695c972">OpenMode</a> = <a class="el" href="namespacetrio.html#a6020d2cf223a27e6f0c208754c379dce">trio::OpenMode</a></td></tr>
|
||
|
|
<tr class="separator:ac7def2dc131ce92fade579b73695c972 inherit pub_types_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pub_static_attribs_classtrio_1_1BoundedIOStream"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classtrio_1_1BoundedIOStream')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="classtrio_1_1BoundedIOStream.html">trio::BoundedIOStream</a></td></tr>
|
||
|
|
<tr class="memitem:a0298a701e6508d21a06a7a12beea4ba2 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structsc_1_1StatusCode.html">sc::StatusCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#a0298a701e6508d21a06a7a12beea4ba2">OpenError</a> {100, "Error opening file"}</td></tr>
|
||
|
|
<tr class="separator:a0298a701e6508d21a06a7a12beea4ba2 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5bca141b1213e5f752a4fde5679708bd inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structsc_1_1StatusCode.html">sc::StatusCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#a5bca141b1213e5f752a4fde5679708bd">ReadError</a> {101, "Error reading file"}</td></tr>
|
||
|
|
<tr class="separator:a5bca141b1213e5f752a4fde5679708bd inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adaa88ae7c4bbeda319710963adc81ce8 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structsc_1_1StatusCode.html">sc::StatusCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#adaa88ae7c4bbeda319710963adc81ce8">WriteError</a> {102, "Error writing file"}</td></tr>
|
||
|
|
<tr class="separator:adaa88ae7c4bbeda319710963adc81ce8 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a20f4c9068fa8d05f6f6135c367fe4d24 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structsc_1_1StatusCode.html">sc::StatusCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#a20f4c9068fa8d05f6f6135c367fe4d24">AlreadyOpenError</a> {103, "File already <a class="el" href="classtrio_1_1Openable.html#addfdc5360983a446fe200410a3eaef8f">open</a>"}</td></tr>
|
||
|
|
<tr class="separator:a20f4c9068fa8d05f6f6135c367fe4d24 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afbe507ff2b39fc2ccb8550dfc27e0ce9 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structsc_1_1StatusCode.html">sc::StatusCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1BoundedIOStream.html#afbe507ff2b39fc2ccb8550dfc27e0ce9">SeekError</a> {104, "Error seeking file"}</td></tr>
|
||
|
|
<tr class="separator:afbe507ff2b39fc2ccb8550dfc27e0ce9 inherit pub_static_attribs_classtrio_1_1BoundedIOStream"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Controllable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Controllable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Controllable.html">trio::Controllable</a></td></tr>
|
||
|
|
<tr class="memitem:a66a85a74eb5921ba18e7d50f16bb3d14 inherit pro_methods_classtrio_1_1Controllable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Controllable.html#a66a85a74eb5921ba18e7d50f16bb3d14">~Controllable</a> ()</td></tr>
|
||
|
|
<tr class="separator:a66a85a74eb5921ba18e7d50f16bb3d14 inherit pro_methods_classtrio_1_1Controllable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Openable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Openable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Openable.html">trio::Openable</a></td></tr>
|
||
|
|
<tr class="memitem:a24782209f544f766b4b953dae7b1dbd4 inherit pro_methods_classtrio_1_1Openable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Openable.html#a24782209f544f766b4b953dae7b1dbd4">~Openable</a> ()</td></tr>
|
||
|
|
<tr class="separator:a24782209f544f766b4b953dae7b1dbd4 inherit pro_methods_classtrio_1_1Openable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Closeable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Closeable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Closeable.html">trio::Closeable</a></td></tr>
|
||
|
|
<tr class="memitem:aebe07ebcbb431ecdd71b575993038097 inherit pro_methods_classtrio_1_1Closeable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Closeable.html#aebe07ebcbb431ecdd71b575993038097">~Closeable</a> ()</td></tr>
|
||
|
|
<tr class="separator:aebe07ebcbb431ecdd71b575993038097 inherit pro_methods_classtrio_1_1Closeable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Readable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Readable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Readable.html">trio::Readable</a></td></tr>
|
||
|
|
<tr class="memitem:a49421a76a150a17207dc2d896d73d7a7 inherit pro_methods_classtrio_1_1Readable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Readable.html#a49421a76a150a17207dc2d896d73d7a7">~Readable</a> ()</td></tr>
|
||
|
|
<tr class="separator:a49421a76a150a17207dc2d896d73d7a7 inherit pro_methods_classtrio_1_1Readable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Writable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Writable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Writable.html">trio::Writable</a></td></tr>
|
||
|
|
<tr class="memitem:aadd7ce033795eb76f383ae341a17aa21 inherit pro_methods_classtrio_1_1Writable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Writable.html#aadd7ce033795eb76f383ae341a17aa21">~Writable</a> ()</td></tr>
|
||
|
|
<tr class="separator:aadd7ce033795eb76f383ae341a17aa21 inherit pro_methods_classtrio_1_1Writable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Seekable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Seekable')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Seekable.html">trio::Seekable</a></td></tr>
|
||
|
|
<tr class="memitem:abbd824465ebc3080b3c1d84f3266bb2d inherit pro_methods_classtrio_1_1Seekable"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Seekable.html#abbd824465ebc3080b3c1d84f3266bb2d">~Seekable</a> ()</td></tr>
|
||
|
|
<tr class="separator:abbd824465ebc3080b3c1d84f3266bb2d inherit pro_methods_classtrio_1_1Seekable"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="inherit_header pro_methods_classtrio_1_1Bounded"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classtrio_1_1Bounded')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classtrio_1_1Bounded.html">trio::Bounded</a></td></tr>
|
||
|
|
<tr class="memitem:a7ea3df0afdd14896c30ae7502dffe2ff inherit pro_methods_classtrio_1_1Bounded"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classtrio_1_1Bounded.html#a7ea3df0afdd14896c30ae7502dffe2ff">~Bounded</a> ()</td></tr>
|
||
|
|
<tr class="separator:a7ea3df0afdd14896c30ae7502dffe2ff inherit pro_methods_classtrio_1_1Bounded"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p >Standard file stream. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="a75e6821531456b6f0238abb2d987a640" name="a75e6821531456b6f0238abb2d987a640"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a75e6821531456b6f0238abb2d987a640">◆ </a></span>FileStream() <span class="overload">[1/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">trio::FileStream::FileStream </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a65809a260adc501a052a7d7476ad1553" name="a65809a260adc501a052a7d7476ad1553"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65809a260adc501a052a7d7476ad1553">◆ </a></span>~FileStream()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">trio::FileStream::~FileStream </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a1d1c14f8be2b90aa32ad07a7605505a4" name="a1d1c14f8be2b90aa32ad07a7605505a4"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d1c14f8be2b90aa32ad07a7605505a4">◆ </a></span>FileStream() <span class="overload">[2/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">trio::FileStream::FileStream </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classtrio_1_1FileStream.html">FileStream</a> & </td>
|
||
|
|
<td class="paramname"></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">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6eea6f8958a7554ec6c0b122b7786abe" name="a6eea6f8958a7554ec6c0b122b7786abe"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6eea6f8958a7554ec6c0b122b7786abe">◆ </a></span>FileStream() <span class="overload">[3/3]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">trio::FileStream::FileStream </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a> && </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a0d6564c770dac2d589f9300e50d6a820" name="a0d6564c770dac2d589f9300e50d6a820"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d6564c770dac2d589f9300e50d6a820">◆ </a></span>create()</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="classtrio_1_1FileStream.html">FileStream</a> * trio::FileStream::create </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char * </td>
|
||
|
|
<td class="paramname"><em>path</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespacetrio.html#a4b77aebe484e434a3112e66b70acd116">AccessMode</a> </td>
|
||
|
|
<td class="paramname"><em>accessMode</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="namespacetrio.html#a6020d2cf223a27e6f0c208754c379dce">OpenMode</a> </td>
|
||
|
|
<td class="paramname"><em>openMode</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="classpma_1_1MemoryResource.html">MemoryResource</a> * </td>
|
||
|
|
<td class="paramname"><em>memRes</em> = <code>nullptr</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Factory method for creation of a <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> instance. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">path</td><td>UTF-8 encoded path to file to be opened. </td></tr>
|
||
|
|
<tr><td class="paramname">accessMode</td><td>Control whether the file is opened for reading or writing. </td></tr>
|
||
|
|
<tr><td class="paramname">openMode</td><td>Control whether the file is opened in binary or textual mode. </td></tr>
|
||
|
|
<tr><td class="paramname">memRes</td><td>The memory resource to be used for the allocation of the <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> instance. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>If a custom memory resource is not given, a default allocation mechanism will be used. </dd></dl>
|
||
|
|
<dl class="section warning"><dt>Warning</dt><dd>User is responsible for releasing the returned pointer by calling destroy. </dd></dl>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtrio_1_1FileStream.html#af77548a526355e8b3d8d890dd9a18789" title="Method for freeing a FileStream instance.">destroy</a> </dd></dl>
|
||
|
|
<div class="fragment"><div class="line"><span class="lineno"> 49</span> {</div>
|
||
|
|
<div class="line"><span class="lineno"> 50</span> <a class="code hl_class" href="classpma_1_1PolyAllocator.html">pma::PolyAllocator<FileStreamImpl></a> alloc{memRes};</div>
|
||
|
|
<div class="line"><span class="lineno"> 51</span> <span class="keywordflow">return</span> alloc.newObject(path, accessMode, openMode, memRes);</div>
|
||
|
|
<div class="line"><span class="lineno"> 52</span>}</div>
|
||
|
|
<div class="ttc" id="aclasspma_1_1PolyAllocator_html"><div class="ttname"><a href="classpma_1_1PolyAllocator.html">pma::PolyAllocator</a></div><div class="ttdef"><b>Definition:</b> PolyAllocator.h:129</div></div>
|
||
|
|
</div><!-- fragment -->
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af77548a526355e8b3d8d890dd9a18789" name="af77548a526355e8b3d8d890dd9a18789"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af77548a526355e8b3d8d890dd9a18789">◆ </a></span>destroy()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void trio::FileStream::destroy </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a> * </td>
|
||
|
|
<td class="paramname"><em>instance</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Method for freeing a <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> instance. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">instance</td><td>Instance of <a class="el" href="classtrio_1_1FileStream.html" title="Standard file stream.">FileStream</a> to be freed. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtrio_1_1FileStream.html#a0d6564c770dac2d589f9300e50d6a820" title="Factory method for creation of a FileStream instance.">create</a> </dd></dl>
|
||
|
|
<div class="fragment"><div class="line"><span class="lineno"> 54</span> {</div>
|
||
|
|
<div class="line"><span class="lineno"> 55</span> <span class="comment">// NOLINTNEXTLINE(cppcoreguidelines-pro-type-static-cast-downcast)</span></div>
|
||
|
|
<div class="line"><span class="lineno"> 56</span> <span class="keyword">auto</span> stream = <span class="keyword">static_cast<</span>FileStreamImpl*<span class="keyword">></span>(instance);</div>
|
||
|
|
<div class="line"><span class="lineno"> 57</span> <a class="code hl_class" href="classpma_1_1PolyAllocator.html">pma::PolyAllocator<FileStreamImpl></a> alloc{stream->getMemoryResource()};</div>
|
||
|
|
<div class="line"><span class="lineno"> 58</span> alloc.deleteObject(stream);</div>
|
||
|
|
<div class="line"><span class="lineno"> 59</span>}</div>
|
||
|
|
</div><!-- fragment -->
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a7f1699314e2e469ae78a1a2b5a635cb5" name="a7f1699314e2e469ae78a1a2b5a635cb5"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f1699314e2e469ae78a1a2b5a635cb5">◆ </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="classtrio_1_1FileStream.html">FileStream</a> & trio::FileStream::operator= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classtrio_1_1FileStream.html">FileStream</a> & </td>
|
||
|
|
<td class="paramname"></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">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a897e527409bd3a3ae8e7ef4a7dc3e5d2" name="a897e527409bd3a3ae8e7ef4a7dc3e5d2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a897e527409bd3a3ae8e7ef4a7dc3e5d2">◆ </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="classtrio_1_1FileStream.html">FileStream</a> & trio::FileStream::operator= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="classtrio_1_1FileStream.html">FileStream</a> && </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li><a class="el" href="FileStream_8h_source.html">FileStream.h</a></li>
|
||
|
|
<li><a class="el" href="FileStreamImpl_8cpp.html">FileStreamImpl.cpp</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|