This commit is contained in:
bthomee
2025-08-19 09:49:50 -07:00
parent bb5efdeec8
commit e7f4ae8bed
14888 changed files with 259444 additions and 168566 deletions

View File

@@ -3,7 +3,7 @@
<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.5"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: Keylet.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<!-- 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');
@@ -46,6 +46,11 @@ $(function() {
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -105,35 +110,39 @@ $(function() {
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">class </span>STLedgerEntry;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="};">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structripple_1_1Keylet.html"> 38</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Keylet.html">Keylet</a></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>{</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db"> 40</a></span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <a class="code hl_variable" href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db">key</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0"> 41</a></span> <a class="code hl_enumeration" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a> <a class="code hl_variable" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="}">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structripple_1_1Keylet.html#a0178242a6b4273e3bd80c15f24ebb35a"> 43</a></span> <a class="code hl_function" href="structripple_1_1Keylet.html#a0178242a6b4273e3bd80c15f24ebb35a">Keylet</a>(<a class="code hl_enumeration" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a> type_, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; key_) : <a class="code hl_variable" href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db">key</a>(key_), <a class="code hl_variable" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a>(type_)</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> }</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_function" href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">check</a>(<a class="code hl_class" href="classripple_1_1STLedgerEntry.html">STLedgerEntry</a> <span class="keyword">const</span>&amp;) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1STLedgerEntry_html"><div class="ttname"><a href="classripple_1_1STLedgerEntry.html">ripple::STLedgerEntry</a></div><div class="ttdef"><b>Definition:</b> <a href="STLedgerEntry_8h_source.html#l00031">STLedgerEntry.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1STLedgerEntry_html"><div class="ttname"><a href="classripple_1_1STLedgerEntry.html">ripple::STLedgerEntry</a></div><div class="ttdef"><b>Definition</b> <a href="STLedgerEntry_8h_source.html#l00031">STLedgerEntry.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</a></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="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">ripple::LedgerEntryType</a></div><div class="ttdeci">LedgerEntryType</div><div class="ttdoc">Identifiers for on-ledger objects.</div><div class="ttdef"><b>Definition:</b> <a href="LedgerFormats_8h_source.html#l00053">LedgerFormats.h:54</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html"><div class="ttname"><a href="structripple_1_1Keylet.html">ripple::Keylet</a></div><div class="ttdoc">A pair of SHAMap key and LedgerEntryType.</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8h_source.html#l00038">Keylet.h:39</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a0178242a6b4273e3bd80c15f24ebb35a"><div class="ttname"><a href="structripple_1_1Keylet.html#a0178242a6b4273e3bd80c15f24ebb35a">ripple::Keylet::Keylet</a></div><div class="ttdeci">Keylet(LedgerEntryType type_, uint256 const &amp;key_)</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8h_source.html#l00043">Keylet.h:43</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a194d83c488eaa909ae4bcf816d8f4cb0"><div class="ttname"><a href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">ripple::Keylet::type</a></div><div class="ttdeci">LedgerEntryType type</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8h_source.html#l00041">Keylet.h:41</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a1e8ccd4a50a894a338c789fc566d8802"><div class="ttname"><a href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">ripple::Keylet::check</a></div><div class="ttdeci">bool check(STLedgerEntry const &amp;) const</div><div class="ttdoc">Returns true if the SLE matches the type.</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8cpp_source.html#l00028">Keylet.cpp:28</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a482983062843a8682fcea76a309c73db"><div class="ttname"><a href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db">ripple::Keylet::key</a></div><div class="ttdeci">uint256 key</div><div class="ttdef"><b>Definition:</b> <a href="Keylet_8h_source.html#l00040">Keylet.h:40</a></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="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac151bf19e1f4daae2b04c65c65117139"><div class="ttname"><a href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">ripple::LedgerEntryType</a></div><div class="ttdeci">LedgerEntryType</div><div class="ttdoc">Identifiers for on-ledger objects.</div><div class="ttdef"><b>Definition</b> <a href="LedgerFormats_8h_source.html#l00053">LedgerFormats.h:54</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html"><div class="ttname"><a href="structripple_1_1Keylet.html">ripple::Keylet</a></div><div class="ttdoc">A pair of SHAMap key and LedgerEntryType.</div><div class="ttdef"><b>Definition</b> <a href="Keylet_8h_source.html#l00038">Keylet.h:39</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a0178242a6b4273e3bd80c15f24ebb35a"><div class="ttname"><a href="structripple_1_1Keylet.html#a0178242a6b4273e3bd80c15f24ebb35a">ripple::Keylet::Keylet</a></div><div class="ttdeci">Keylet(LedgerEntryType type_, uint256 const &amp;key_)</div><div class="ttdef"><b>Definition</b> <a href="Keylet_8h_source.html#l00043">Keylet.h:43</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a194d83c488eaa909ae4bcf816d8f4cb0"><div class="ttname"><a href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">ripple::Keylet::type</a></div><div class="ttdeci">LedgerEntryType type</div><div class="ttdef"><b>Definition</b> <a href="Keylet_8h_source.html#l00041">Keylet.h:41</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a1e8ccd4a50a894a338c789fc566d8802"><div class="ttname"><a href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">ripple::Keylet::check</a></div><div class="ttdeci">bool check(STLedgerEntry const &amp;) const</div><div class="ttdoc">Returns true if the SLE matches the type.</div><div class="ttdef"><b>Definition</b> <a href="Keylet_8cpp_source.html#l00028">Keylet.cpp:28</a></div></div>
<div class="ttc" id="astructripple_1_1Keylet_html_a482983062843a8682fcea76a309c73db"><div class="ttname"><a href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db">ripple::Keylet::key</a></div><div class="ttdeci">uint256 key</div><div class="ttdef"><b>Definition</b> <a href="Keylet_8h_source.html#l00040">Keylet.h:40</a></div></div>
</div><!-- fragment --></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.5
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>