Files
rippled/classripple_1_1scope__success.html
2025-08-19 09:49:50 -07:00

359 lines
19 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" 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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::scope_success&lt; EF &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>
<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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(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">
<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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1scope__success.html">scope_success</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1scope__success-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::scope_success&lt; EF &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="scope_8h_source.html">scope.h</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:adec62bf052cdfe14299556d1e3df85c0" id="r_adec62bf052cdfe14299556d1e3df85c0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#adec62bf052cdfe14299556d1e3df85c0">~scope_success</a> () noexcept(noexcept(<a class="el" href="classripple_1_1scope__success.html#a4573a69e7e61b0f912e2db7137666d29">exit_function_</a>()))</td></tr>
<tr class="separator:adec62bf052cdfe14299556d1e3df85c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabd51b5cb12949d649d5eb81f7a9edae" id="r_aabd51b5cb12949d649d5eb81f7a9edae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#aabd51b5cb12949d649d5eb81f7a9edae">scope_success</a> (<a class="el" href="classripple_1_1scope__success.html">scope_success</a> &amp;&amp;rhs) noexcept(<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_move_constructible.html">std::is_nothrow_move_constructible_v</a>&lt; EF &gt;||<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_copy_constructible.html">std::is_nothrow_copy_constructible_v</a>&lt; EF &gt;)</td></tr>
<tr class="separator:aabd51b5cb12949d649d5eb81f7a9edae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80f39ff53ef41ff6300d8292be9d20f2" id="r_a80f39ff53ef41ff6300d8292be9d20f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1scope__success.html">scope_success</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#a80f39ff53ef41ff6300d8292be9d20f2">operator=</a> (<a class="el" href="classripple_1_1scope__success.html">scope_success</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a80f39ff53ef41ff6300d8292be9d20f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff96caec2314853be8435e3d1e2fba0f" id="r_aff96caec2314853be8435e3d1e2fba0f"><td class="memTemplParams" colspan="2">template&lt;class EFP &gt; </td></tr>
<tr class="memitem:aff96caec2314853be8435e3d1e2fba0f"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#aff96caec2314853be8435e3d1e2fba0f">scope_success</a> (EFP &amp;&amp;f, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt; !<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/remove_cv.html">std::remove_cv_t</a>&lt; EFP &gt;, <a class="el" href="classripple_1_1scope__success.html">scope_success</a> &gt; &amp;&amp;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_constructible.html">std::is_constructible_v</a>&lt; EF, EFP &gt; &gt; *=0) noexcept(<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_constructible.html">std::is_nothrow_constructible_v</a>&lt; EF, EFP &gt;||<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_constructible.html">std::is_nothrow_constructible_v</a>&lt; EF, EFP &amp; &gt;)</td></tr>
<tr class="separator:aff96caec2314853be8435e3d1e2fba0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a872976a2e74fbe290c1d474f27905317" id="r_a872976a2e74fbe290c1d474f27905317"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#a872976a2e74fbe290c1d474f27905317">release</a> () noexcept</td></tr>
<tr class="separator:a872976a2e74fbe290c1d474f27905317"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a4573a69e7e61b0f912e2db7137666d29" id="r_a4573a69e7e61b0f912e2db7137666d29"><td class="memItemLeft" align="right" valign="top">EF&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#a4573a69e7e61b0f912e2db7137666d29">exit_function_</a></td></tr>
<tr class="separator:a4573a69e7e61b0f912e2db7137666d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4828166491efb93806680352c1a2a902" id="r_a4828166491efb93806680352c1a2a902"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#a4828166491efb93806680352c1a2a902">execute_on_destruction_</a> {true}</td></tr>
<tr class="separator:a4828166491efb93806680352c1a2a902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca3c3be1a92357527af10dbe775e1364" id="r_aca3c3be1a92357527af10dbe775e1364"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1scope__success.html#aca3c3be1a92357527af10dbe775e1364">uncaught_on_creation_</a> {<a class="elRef" href="http://en.cppreference.com/w/cpp/error/uncaught_exception.html">std::uncaught_exceptions</a>()}</td></tr>
<tr class="separator:aca3c3be1a92357527af10dbe775e1364"><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;class EF&gt;<br />
class ripple::scope_success&lt; EF &gt;</div>
<p class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00144">144</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="adec62bf052cdfe14299556d1e3df85c0" name="adec62bf052cdfe14299556d1e3df85c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adec62bf052cdfe14299556d1e3df85c0">&#9670;&#160;</a></span>~scope_success()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::~<a class="el" href="classripple_1_1scope__success.html">scope_success</a> </td>
<td>(</td>
<td class="paramname"></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 class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00151">151</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<a id="aabd51b5cb12949d649d5eb81f7a9edae" name="aabd51b5cb12949d649d5eb81f7a9edae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabd51b5cb12949d649d5eb81f7a9edae">&#9670;&#160;</a></span>scope_success() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::scope_success </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1scope__success.html">scope_success</a>&lt; EF &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>rhs</em></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 class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00158">158</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<a id="aff96caec2314853be8435e3d1e2fba0f" name="aff96caec2314853be8435e3d1e2fba0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff96caec2314853be8435e3d1e2fba0f">&#9670;&#160;</a></span>scope_success() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<div class="memtemplate">
template&lt;class EFP &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::scope_success </td>
<td>(</td>
<td class="paramtype">EFP &amp;&amp;&#160;</td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt; !<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/remove_cv.html">std::remove_cv_t</a>&lt; EFP &gt;, <a class="el" href="classripple_1_1scope__success.html">scope_success</a>&lt; EF &gt; &gt; &amp;&amp;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_constructible.html">std::is_constructible_v</a>&lt; EF, EFP &gt; &gt; *&#160;</td>
<td class="paramname"> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00172">172</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a80f39ff53ef41ff6300d8292be9d20f2" name="a80f39ff53ef41ff6300d8292be9d20f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80f39ff53ef41ff6300d8292be9d20f2">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1scope__success.html">scope_success</a> &amp; <a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1scope__success.html">scope_success</a>&lt; EF &gt; &amp;&amp;&#160;</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="a872976a2e74fbe290c1d474f27905317" name="a872976a2e74fbe290c1d474f27905317"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a872976a2e74fbe290c1d474f27905317">&#9670;&#160;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::release </td>
<td>(</td>
<td class="paramname"></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 class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00183">183</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4573a69e7e61b0f912e2db7137666d29" name="a4573a69e7e61b0f912e2db7137666d29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4573a69e7e61b0f912e2db7137666d29">&#9670;&#160;</a></span>exit_function_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">EF <a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::exit_function_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00146">146</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<a id="a4828166491efb93806680352c1a2a902" name="a4828166491efb93806680352c1a2a902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4828166491efb93806680352c1a2a902">&#9670;&#160;</a></span>execute_on_destruction_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::execute_on_destruction_ {true}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00147">147</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
<a id="aca3c3be1a92357527af10dbe775e1364" name="aca3c3be1a92357527af10dbe775e1364"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca3c3be1a92357527af10dbe775e1364">&#9670;&#160;</a></span>uncaught_on_creation_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EF &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classripple_1_1scope__success.html">ripple::scope_success</a>&lt; EF &gt;::uncaught_on_creation_ {<a class="elRef" href="http://en.cppreference.com/w/cpp/error/uncaught_exception.html">std::uncaught_exceptions</a>()}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="scope_8h_source.html#l00148">148</a> of file <a class="el" href="scope_8h_source.html">scope.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>