Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
stdex/classstdex_1_1ref__unique__ptr.html

281 lines
14 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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::ref_unique_ptr&lt; T, D &gt; Class Template 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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">stdex
</div>
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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>
<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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1ref__unique__ptr.html">ref_unique_ptr</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="#pro-attribs">Protected Attributes</a> &#124;
<a href="classstdex_1_1ref__unique__ptr-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stdex::ref_unique_ptr&lt; T, D &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Helper class for returning pointers to std::unique_ptr.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="memory_8hpp_source.html">stdex/memory.hpp</a>&gt;</code></p>
<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:ae2a91bea8e3ca3959028b8551b05cf35" id="r_ae2a91bea8e3ca3959028b8551b05cf35"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2a91bea8e3ca3959028b8551b05cf35">ref_unique_ptr</a> (std::unique_ptr&lt; T, D &gt; &amp;owner)</td></tr>
<tr class="memdesc:ae2a91bea8e3ca3959028b8551b05cf35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Takes ownership of the pointer. <br /></td></tr>
<tr class="separator:ae2a91bea8e3ca3959028b8551b05cf35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4efce8a29283ec24bb5fba0523d18dc0" id="r_a4efce8a29283ec24bb5fba0523d18dc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4efce8a29283ec24bb5fba0523d18dc0">ref_unique_ptr</a> (<a class="el" href="classstdex_1_1ref__unique__ptr.html">ref_unique_ptr</a>&lt; T, D &gt; &amp;&amp;other)</td></tr>
<tr class="memdesc:a4efce8a29283ec24bb5fba0523d18dc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves object. <br /></td></tr>
<tr class="separator:a4efce8a29283ec24bb5fba0523d18dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a585cdfa8c634099e7b20aefb3ee2cd7a" id="r_a585cdfa8c634099e7b20aefb3ee2cd7a"><td class="memItemLeft" align="right" valign="top"><a id="a585cdfa8c634099e7b20aefb3ee2cd7a" name="a585cdfa8c634099e7b20aefb3ee2cd7a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~ref_unique_ptr</b> ()</td></tr>
<tr class="memdesc:a585cdfa8c634099e7b20aefb3ee2cd7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns ownership of the pointer. <br /></td></tr>
<tr class="separator:a585cdfa8c634099e7b20aefb3ee2cd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7531b9afc7bfd4946cb0fdc3c39c7389" id="r_a7531b9afc7bfd4946cb0fdc3c39c7389"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7531b9afc7bfd4946cb0fdc3c39c7389">operator T**</a> ()</td></tr>
<tr class="memdesc:a7531b9afc7bfd4946cb0fdc3c39c7389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator for pointer-to-pointer parameters by value use-cases. <br /></td></tr>
<tr class="separator:a7531b9afc7bfd4946cb0fdc3c39c7389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4ea17186d427f51595b71be31e4221e" id="r_ac4ea17186d427f51595b71be31e4221e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac4ea17186d427f51595b71be31e4221e">operator T*&amp;</a> ()</td></tr>
<tr class="memdesc:ac4ea17186d427f51595b71be31e4221e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator for reverence-to-pointer parameters by value use-cases. <br /></td></tr>
<tr class="separator:ac4ea17186d427f51595b71be31e4221e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aefbe3552d49828e8ef176d9e957a1c6a" id="r_aefbe3552d49828e8ef176d9e957a1c6a"><td class="memItemLeft" align="right" valign="top"><a id="aefbe3552d49828e8ef176d9e957a1c6a" name="aefbe3552d49828e8ef176d9e957a1c6a"></a>
std::unique_ptr&lt; T, D &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m_own</b></td></tr>
<tr class="memdesc:aefbe3552d49828e8ef176d9e957a1c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Original owner of the pointer. <br /></td></tr>
<tr class="separator:aefbe3552d49828e8ef176d9e957a1c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5831f44229b63ef804f0f86f7fa7c433" id="r_a5831f44229b63ef804f0f86f7fa7c433"><td class="memItemLeft" align="right" valign="top"><a id="a5831f44229b63ef804f0f86f7fa7c433" name="a5831f44229b63ef804f0f86f7fa7c433"></a>
T *&#160;</td><td class="memItemRight" valign="bottom"><b>m_ptr</b></td></tr>
<tr class="memdesc:a5831f44229b63ef804f0f86f7fa7c433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer. <br /></td></tr>
<tr class="separator:a5831f44229b63ef804f0f86f7fa7c433"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T, typename D&gt;<br />
class stdex::ref_unique_ptr&lt; T, D &gt;</div><p>Helper class for returning pointers to std::unique_ptr. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae2a91bea8e3ca3959028b8551b05cf35" name="ae2a91bea8e3ca3959028b8551b05cf35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2a91bea8e3ca3959028b8551b05cf35">&#9670;&#160;</a></span>ref_unique_ptr() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename D &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1ref__unique__ptr.html">stdex::ref_unique_ptr</a>&lt; T, D &gt;::ref_unique_ptr </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; T, D &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>owner</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes ownership of the pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">owner</td><td>Object to attach helper to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4efce8a29283ec24bb5fba0523d18dc0" name="a4efce8a29283ec24bb5fba0523d18dc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4efce8a29283ec24bb5fba0523d18dc0">&#9670;&#160;</a></span>ref_unique_ptr() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename D &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1ref__unique__ptr.html">stdex::ref_unique_ptr</a>&lt; T, D &gt;::ref_unique_ptr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstdex_1_1ref__unique__ptr.html">ref_unique_ptr</a>&lt; T, D &gt; &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">other</td><td>Source object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac4ea17186d427f51595b71be31e4221e" name="ac4ea17186d427f51595b71be31e4221e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4ea17186d427f51595b71be31e4221e">&#9670;&#160;</a></span>operator T*&amp;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename D &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1ref__unique__ptr.html">stdex::ref_unique_ptr</a>&lt; T, D &gt;::operator T*&amp; </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Operator for reverence-to-pointer parameters by value use-cases. </p>
<dl class="section return"><dt>Returns</dt><dd>Reference to the pointer </dd></dl>
</div>
</div>
<a id="a7531b9afc7bfd4946cb0fdc3c39c7389" name="a7531b9afc7bfd4946cb0fdc3c39c7389"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7531b9afc7bfd4946cb0fdc3c39c7389">&#9670;&#160;</a></span>operator T**()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , typename D &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstdex_1_1ref__unique__ptr.html">stdex::ref_unique_ptr</a>&lt; T, D &gt;::operator T** </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Operator for pointer-to-pointer parameters by value use-cases. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the pointer </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/stdex/<a class="el" href="memory_8hpp_source.html">memory.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Oct 1 2024 11:47:56 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink