Files
rippled/classripple_1_1Expected_3_01void_00_01E_01_4.html
2025-11-04 00:36:48 -08:00

315 lines
16 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::Expected&lt; void, E &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_1Expected_3_01void_00_01E_01_4.html">Expected&lt; void, E &gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="classripple_1_1Expected_3_01void_00_01E_01_4-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Expected&lt; void, E &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Expected_8h_source.html">Expected.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Expected&lt; void, E &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Expected_3_01void_00_01E_01_4__inherit__graph.png" border="0" usemap="#aripple_1_1Expected_3_01void_00_01E_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Expected_3_01void_00_01E_01_4_inherit__map" id="aripple_1_1Expected_3_01void_00_01E_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,108,207,133"/>
<area shape="rect" title=" " alt="" coords="25,5,187,60"/>
<area shape="poly" title=" " alt="" coords="109,74,109,108,103,108,103,74"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::Expected&lt; void, E &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Expected_3_01void_00_01E_01_4__coll__graph.png" border="0" usemap="#aripple_1_1Expected_3_01void_00_01E_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Expected_3_01void_00_01E_01_4_coll__map" id="aripple_1_1Expected_3_01void_00_01E_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,108,207,133"/>
<area shape="rect" title=" " alt="" coords="25,5,187,60"/>
<area shape="poly" title=" " alt="" coords="109,74,109,108,103,108,103,74"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:ac09eba67ca2af549969bdcaeedfb36c4" id="r_ac09eba67ca2af549969bdcaeedfb36c4"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#ac09eba67ca2af549969bdcaeedfb36c4">Expected</a> ()</td></tr>
<tr class="separator:ac09eba67ca2af549969bdcaeedfb36c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867c25176d4adba0e51dd6489d20214a" id="r_a867c25176d4adba0e51dd6489d20214a"><td class="memTemplParams" colspan="2">template&lt;typename U &gt; <br />
requires <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::convertible_to</a>&lt;U, E&gt; &amp;&amp; (!<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_reference.html">std::is_reference_v</a>&lt;U&gt;)</td></tr>
<tr class="memitem:a867c25176d4adba0e51dd6489d20214a"><td class="memTemplItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#a867c25176d4adba0e51dd6489d20214a">Expected</a> (<a class="el" href="classripple_1_1Unexpected.html">Unexpected</a>&lt; U &gt; e)</td></tr>
<tr class="separator:a867c25176d4adba0e51dd6489d20214a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ee95ac6cdd87d40a3133c07851d59de" id="r_a2ee95ac6cdd87d40a3133c07851d59de"><td class="memItemLeft" align="right" valign="top">constexpr E const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#a2ee95ac6cdd87d40a3133c07851d59de">error</a> () const</td></tr>
<tr class="separator:a2ee95ac6cdd87d40a3133c07851d59de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4f0eec68a28f7c21b4848d3e8c76059" id="r_ab4f0eec68a28f7c21b4848d3e8c76059"><td class="memItemLeft" align="right" valign="top">constexpr E &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#ab4f0eec68a28f7c21b4848d3e8c76059">error</a> ()</td></tr>
<tr class="separator:ab4f0eec68a28f7c21b4848d3e8c76059"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc08b172d26c725b644a19bf3ebeebb7" id="r_abc08b172d26c725b644a19bf3ebeebb7"><td class="memItemLeft" align="right" valign="top">constexpr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#abc08b172d26c725b644a19bf3ebeebb7">operator bool</a> () const</td></tr>
<tr class="separator:abc08b172d26c725b644a19bf3ebeebb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ab64f7ea889ad57b9d4fb6c12abd03042" id="r_ab64f7ea889ad57b9d4fb6c12abd03042"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Expected_3_01void_00_01E_01_4.html#ab64f7ea889ad57b9d4fb6c12abd03042">Base</a> = boost::outcome_v2::result&lt; void, E, <a class="el" href="structripple_1_1detail_1_1throw__policy.html">detail::throw_policy</a> &gt;</td></tr>
<tr class="separator:ab64f7ea889ad57b9d4fb6c12abd03042"><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 E&gt;<br />
class ripple::Expected&lt; void, E &gt;</div>
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00198">198</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab64f7ea889ad57b9d4fb6c12abd03042" name="ab64f7ea889ad57b9d4fb6c12abd03042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab64f7ea889ad57b9d4fb6c12abd03042">&#9670;&#160;</a></span>Base</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::Base = boost::outcome_v2::result&lt;void, E, <a class="el" href="structripple_1_1detail_1_1throw__policy.html">detail::throw_policy</a>&gt;</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="Expected_8h_source.html#l00201">201</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac09eba67ca2af549969bdcaeedfb36c4" name="ac09eba67ca2af549969bdcaeedfb36c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac09eba67ca2af549969bdcaeedfb36c4">&#9670;&#160;</a></span>Expected() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::Expected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00206">206</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div>
</div>
<a id="a867c25176d4adba0e51dd6489d20214a" name="a867c25176d4adba0e51dd6489d20214a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a867c25176d4adba0e51dd6489d20214a">&#9670;&#160;</a></span>Expected() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<div class="memtemplate">
template&lt;typename U &gt; <br />
requires <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::convertible_to</a>&lt;U, E&gt; &amp;&amp; (!<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_reference.html">std::is_reference_v</a>&lt;U&gt;)</div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::Expected </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Unexpected.html">Unexpected</a>&lt; U &gt;&#160;</td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00212">212</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2ee95ac6cdd87d40a3133c07851d59de" name="a2ee95ac6cdd87d40a3133c07851d59de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ee95ac6cdd87d40a3133c07851d59de">&#9670;&#160;</a></span>error() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr E const &amp; <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00217">217</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div>
</div>
<a id="ab4f0eec68a28f7c21b4848d3e8c76059" name="ab4f0eec68a28f7c21b4848d3e8c76059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4f0eec68a28f7c21b4848d3e8c76059">&#9670;&#160;</a></span>error() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr E &amp; <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::error </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00223">223</a> of file <a class="el" href="Expected_8h_source.html">Expected.h</a>.</p>
</div>
</div>
<a id="abc08b172d26c725b644a19bf3ebeebb7" name="abc08b172d26c725b644a19bf3ebeebb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc08b172d26c725b644a19bf3ebeebb7">&#9670;&#160;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classripple_1_1Expected.html">ripple::Expected</a>&lt; void, E &gt;::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Expected_8h_source.html#l00229">229</a> of file <a class="el" href="Expected_8h_source.html">Expected.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>