mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 03:26:01 +00:00
178 lines
21 KiB
HTML
178 lines
21 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=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: require.h Source File</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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="dir_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">require.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_TEST_JTX_REQUIRE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_TEST_JTX_REQUIRE_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <test/jtx/requires.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/functional.html">functional</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a>></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>test {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>jtx {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>detail {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span> <<span class="keyword">class </span>Cond, <span class="keyword">class</span>... Args></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">inline</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx_1_1detail.html#a7058607f9e8bbdd85c7bcae916b0851b"> 36</a></span> <a class="code" href="namespaceripple_1_1test_1_1jtx_1_1detail.html#a7058607f9e8bbdd85c7bcae916b0851b">require_args</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">requires_t</a>& vec,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  Cond <span class="keyword">const</span>& cond, Args <span class="keyword">const</span>&... args)</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  vec.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">push_back</a>(cond);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> constexpr (<span class="keyword">sizeof</span>...(args) > 0)</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespaceripple_1_1test_1_1jtx_1_1detail.html#a7058607f9e8bbdd85c7bcae916b0851b">require_args</a>(vec, args...);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> } <span class="comment">// detail</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">template</span> <<span class="keyword">class</span>...Args></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">require_t</a></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx.html#a7c64363fc49c3642ae628d349a50f425"> 49</a></span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#a7c64363fc49c3642ae628d349a50f425">required</a> (Args <span class="keyword">const</span>&... args)</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">requires_t</a> vec;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="namespaceripple_1_1test_1_1jtx_1_1detail.html#a7058607f9e8bbdd85c7bcae916b0851b">detail::require_args</a>(vec, args...);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> [vec](<a class="code" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>& env)</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">for</span>(<span class="keyword">auto</span> <span class="keyword">const</span>& f : vec)</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  f(env);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> }</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1require.html"> 66</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1test_1_1jtx_1_1require.html">require</a></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1require.html#a70ec0229194a37cdd26393c0f5be19dc"> 69</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">require_t</a> <a class="code" href="classripple_1_1test_1_1jtx_1_1require.html#a70ec0229194a37cdd26393c0f5be19dc">cond_</a>;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">template</span><<span class="keyword">class</span>... Args></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1require.html#a2ce59a920ddc43777edda357c3363495"> 73</a></span>  <a class="code" href="classripple_1_1test_1_1jtx_1_1require.html#a2ce59a920ddc43777edda357c3363495">require</a>(Args <span class="keyword">const</span>&... args)</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  : <a class="code" href="classripple_1_1test_1_1jtx_1_1require.html#a70ec0229194a37cdd26393c0f5be19dc">cond_</a>(<a class="code" href="namespaceripple_1_1test_1_1jtx.html#a7c64363fc49c3642ae628d349a50f425">required</a>(args...))</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classripple_1_1test_1_1jtx_1_1require.html#aa659c331e2c77b577b98fcac1ffbe2a9"> 79</a></span>  <a class="code" href="classripple_1_1test_1_1jtx_1_1require.html#aa659c331e2c77b577b98fcac1ffbe2a9">operator()</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1Env.html">Env</a>&, <a class="code" href="structripple_1_1test_1_1jtx_1_1JTx.html">JTx</a>& jt)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  jt.<a class="code" href="structripple_1_1test_1_1jtx_1_1JTx.html#a03cdc7aa0cc8605e942ef060fc00c70e">requires</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector/emplace_back.html">emplace_back</a>(<a class="code" href="classripple_1_1test_1_1jtx_1_1require.html#a70ec0229194a37cdd26393c0f5be19dc">cond_</a>);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> };</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <span class="comment">// jtx</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> } <span class="comment">// test</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> } <span class="comment">// ripple</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1detail_html_a7058607f9e8bbdd85c7bcae916b0851b"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1detail.html#a7058607f9e8bbdd85c7bcae916b0851b">ripple::test::jtx::detail::require_args</a></div><div class="ttdeci">void require_args(requires_t &vec, Cond const &cond, Args const &... args)</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00036">require.h:36</a></div></div>
|
|
<div class="ttc" id="afunctional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/functional.html">functional</a></div></div>
|
|
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/vector.html">vector</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1require_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1require.html">ripple::test::jtx::require</a></div><div class="ttdoc">Check a set of conditions.</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00066">require.h:66</a></div></div>
|
|
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function< void(Env &)></a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1require_html_a2ce59a920ddc43777edda357c3363495"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1require.html#a2ce59a920ddc43777edda357c3363495">ripple::test::jtx::require::require</a></div><div class="ttdeci">require(Args const &... args)</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00073">require.h:73</a></div></div>
|
|
<div class="ttc" id="apush_back_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/push_back.html">std::vector::push_back</a></div><div class="ttdeci">T push_back(T... args)</div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1require_html_aa659c331e2c77b577b98fcac1ffbe2a9"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1require.html#aa659c331e2c77b577b98fcac1ffbe2a9">ripple::test::jtx::require::operator()</a></div><div class="ttdeci">void operator()(Env &, JTx &jt) const</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00079">require.h:79</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1JTx_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1JTx.html">ripple::test::jtx::JTx</a></div><div class="ttdoc">Execution context for applying a JSON transaction.</div><div class="ttdef"><b>Definition:</b> <a href="JTx_8h_source.html#l00041">JTx.h:41</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1require_html_a70ec0229194a37cdd26393c0f5be19dc"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1require.html#a70ec0229194a37cdd26393c0f5be19dc">ripple::test::jtx::require::cond_</a></div><div class="ttdeci">require_t cond_</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00069">require.h:69</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_a7c64363fc49c3642ae628d349a50f425"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#a7c64363fc49c3642ae628d349a50f425">ripple::test::jtx::required</a></div><div class="ttdeci">require_t required(Args const &... args)</div><div class="ttdoc">Compose many condition functors into one.</div><div class="ttdef"><b>Definition:</b> <a href="require_8h_source.html#l00049">require.h:49</a></div></div>
|
|
<div class="ttc" id="aemplace_back_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector/emplace_back.html">std::vector::emplace_back</a></div><div class="ttdeci">T emplace_back(T... args)</div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1JTx_html_a03cdc7aa0cc8605e942ef060fc00c70e"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1JTx.html#a03cdc7aa0cc8605e942ef060fc00c70e">ripple::test::jtx::JTx::requires</a></div><div class="ttdeci">requires_t requires</div><div class="ttdef"><b>Definition:</b> <a href="JTx_8h_source.html#l00044">JTx.h:44</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Env.html">ripple::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition:</b> <a href="Env_8h_source.html#l00117">Env.h:117</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|