ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/structripple_1_1Keylet.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

216 lines
12 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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Keylet Struct 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.5 -->
<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="structripple_1_1Keylet.html">Keylet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1Keylet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Keylet Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A pair of <a class="el" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan-out of 16 and a Merkle tree.">SHAMap</a> key and LedgerEntryType.
<a href="structripple_1_1Keylet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Keylet_8h_source.html">Keylet.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::Keylet:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1Keylet__coll__graph.png" border="0" usemap="#aripple_1_1Keylet_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1Keylet_coll__map" id="aripple_1_1Keylet_coll__map">
<area shape="rect" title="A pair of SHAMap key and LedgerEntryType." alt="" coords="53,313,161,339"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="36,211,177,251"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="5,101,93,126"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="117,93,285,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="150,5,253,31"/>
</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:a0178242a6b4273e3bd80c15f24ebb35a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Keylet.html#a0178242a6b4273e3bd80c15f24ebb35a">Keylet</a> (<a class="el" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a> type_, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;key_)</td></tr>
<tr class="separator:a0178242a6b4273e3bd80c15f24ebb35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e8ccd4a50a894a338c789fc566d8802"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">check</a> (<a class="el" href="classripple_1_1STLedgerEntry.html">STLedgerEntry</a> const &amp;) const</td></tr>
<tr class="memdesc:a1e8ccd4a50a894a338c789fc566d8802"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the SLE matches the type. <a href="structripple_1_1Keylet.html#a1e8ccd4a50a894a338c789fc566d8802">More...</a><br /></td></tr>
<tr class="separator:a1e8ccd4a50a894a338c789fc566d8802"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a482983062843a8682fcea76a309c73db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Keylet.html#a482983062843a8682fcea76a309c73db">key</a></td></tr>
<tr class="separator:a482983062843a8682fcea76a309c73db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a194d83c488eaa909ae4bcf816d8f4cb0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1Keylet.html#a194d83c488eaa909ae4bcf816d8f4cb0">type</a></td></tr>
<tr class="separator:a194d83c488eaa909ae4bcf816d8f4cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A pair of <a class="el" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan-out of 16 and a Merkle tree.">SHAMap</a> key and LedgerEntryType. </p>
<p >A <a class="el" href="structripple_1_1Keylet.html" title="A pair of SHAMap key and LedgerEntryType.">Keylet</a> identifies both a key in the state map and its ledger entry type.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="structripple_1_1Keylet.html" title="A pair of SHAMap key and LedgerEntryType.">Keylet</a> is a portmanteau of the words key and LET, an acronym for LedgerEntryType. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Keylet_8h_source.html#l00038">38</a> of file <a class="el" href="Keylet_8h_source.html">Keylet.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0178242a6b4273e3bd80c15f24ebb35a" name="a0178242a6b4273e3bd80c15f24ebb35a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0178242a6b4273e3bd80c15f24ebb35a">&#9670;&#160;</a></span>Keylet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::Keylet::Keylet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a>&#160;</td>
<td class="paramname"><em>type_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>key_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Keylet_8h_source.html#l00043">43</a> of file <a class="el" href="Keylet_8h_source.html">Keylet.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1e8ccd4a50a894a338c789fc566d8802" name="a1e8ccd4a50a894a338c789fc566d8802"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e8ccd4a50a894a338c789fc566d8802">&#9670;&#160;</a></span>check()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::Keylet::check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STLedgerEntry.html">STLedgerEntry</a> const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the SLE matches the type. </p>
<p class="definition">Definition at line <a class="el" href="Keylet_8cpp_source.html#l00026">26</a> of file <a class="el" href="Keylet_8cpp_source.html">Keylet.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a482983062843a8682fcea76a309c73db" name="a482983062843a8682fcea76a309c73db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a482983062843a8682fcea76a309c73db">&#9670;&#160;</a></span>key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> ripple::Keylet::key</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Keylet_8h_source.html#l00040">40</a> of file <a class="el" href="Keylet_8h_source.html">Keylet.h</a>.</p>
</div>
</div>
<a id="a194d83c488eaa909ae4bcf816d8f4cb0" name="a194d83c488eaa909ae4bcf816d8f4cb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a194d83c488eaa909ae4bcf816d8f4cb0">&#9670;&#160;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#ac151bf19e1f4daae2b04c65c65117139">LedgerEntryType</a> ripple::Keylet::type</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Keylet_8h_source.html#l00041">41</a> of file <a class="el" href="Keylet_8h_source.html">Keylet.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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink