mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-24 04:55:52 +00:00
1585 lines
99 KiB
HTML
1585 lines
99 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.5"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::ApplyView Class 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&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&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_1ApplyView.html">ApplyView</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="classripple_1_1ApplyView-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::ApplyView Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Writeable view to a ledger, for applying a transaction.
|
|
<a href="classripple_1_1ApplyView.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::ApplyView:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1ApplyView__inherit__graph.png" border="0" usemap="#aripple_1_1ApplyView_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1ApplyView_inherit__map" id="aripple_1_1ApplyView_inherit__map">
|
|
<area shape="rect" title="Writeable view to a ledger, for applying a transaction." alt="" coords="217,79,353,104"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ApplyViewBase.html" title=" " alt="" coords="179,152,392,177"/>
|
|
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="219,5,351,31"/>
|
|
<area shape="rect" href="classripple_1_1ApplyViewImpl.html" title="Editable, discardable view that can build metadata for one tx." alt="" coords="5,225,171,251"/>
|
|
<area shape="rect" href="classripple_1_1PaymentSandbox.html" title="A wrapper which makes credits unavailable to balances." alt="" coords="195,225,375,251"/>
|
|
<area shape="rect" href="classripple_1_1Sandbox.html" title="Discardable, editable view to a ledger." alt="" coords="400,225,523,251"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::ApplyView:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1ApplyView__coll__graph.png" border="0" usemap="#aripple_1_1ApplyView_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1ApplyView_coll__map" id="aripple_1_1ApplyView_coll__map">
|
|
<area shape="rect" title="Writeable view to a ledger, for applying a transaction." alt="" coords="253,5,389,31"/>
|
|
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="5,121,137,147"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="228,55,415,95"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="233,245,410,285"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="464,99,665,124"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="467,200,662,225"/>
|
|
</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-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ab1430dec61fd5ef9bf4a013aab558d71"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1STTx.html">STTx</a> const >, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1STObject.html">STObject</a> const > ></td></tr>
|
|
<tr class="separator:ab1430dec61fd5ef9bf4a013aab558d71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a937328125a7d62270f32b4e1555c5cdd"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
|
|
<tr class="separator:a937328125a7d62270f32b4e1555c5cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c7268164504d76bee886f296b15e814"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a0c7268164504d76bee886f296b15e814">mapped_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const ></td></tr>
|
|
<tr class="separator:a0c7268164504d76bee886f296b15e814"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a39cfbb5c7bf09c07ef0386c78b321b7e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a39cfbb5c7bf09c07ef0386c78b321b7e">ApplyView</a> ()=default</td></tr>
|
|
<tr class="separator:a39cfbb5c7bf09c07ef0386c78b321b7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaed5d7cc6edfce1a9f88e50d65c876f1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#aaed5d7cc6edfce1a9f88e50d65c876f1">flags</a> () const =0</td></tr>
|
|
<tr class="memdesc:aaed5d7cc6edfce1a9f88e50d65c876f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the tx apply flags. <a href="classripple_1_1ApplyView.html#aaed5d7cc6edfce1a9f88e50d65c876f1">More...</a><br /></td></tr>
|
|
<tr class="separator:aaed5d7cc6edfce1a9f88e50d65c876f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa666aaa8eb0080d96f910f8a719291d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#afa666aaa8eb0080d96f910f8a719291d">peek</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &k)=0</td></tr>
|
|
<tr class="memdesc:afa666aaa8eb0080d96f910f8a719291d"><td class="mdescLeft"> </td><td class="mdescRight">Prepare to modify the SLE associated with key. <a href="classripple_1_1ApplyView.html#afa666aaa8eb0080d96f910f8a719291d">More...</a><br /></td></tr>
|
|
<tr class="separator:afa666aaa8eb0080d96f910f8a719291d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afda9c12acbda605becf20f54d45587d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#afda9c12acbda605becf20f54d45587d4">erase</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &sle)=0</td></tr>
|
|
<tr class="memdesc:afda9c12acbda605becf20f54d45587d4"><td class="mdescLeft"> </td><td class="mdescRight">Remove a peeked SLE. <a href="classripple_1_1ApplyView.html#afda9c12acbda605becf20f54d45587d4">More...</a><br /></td></tr>
|
|
<tr class="separator:afda9c12acbda605becf20f54d45587d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3c5b5cd9dca5f906be4b36640706e3c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#aa3c5b5cd9dca5f906be4b36640706e3c">insert</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &sle)=0</td></tr>
|
|
<tr class="memdesc:aa3c5b5cd9dca5f906be4b36640706e3c"><td class="mdescLeft"> </td><td class="mdescRight">Insert a new state SLE. <a href="classripple_1_1ApplyView.html#aa3c5b5cd9dca5f906be4b36640706e3c">More...</a><br /></td></tr>
|
|
<tr class="separator:aa3c5b5cd9dca5f906be4b36640706e3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a469fe9366dd58b47c9b29ba98bd3fc8d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a469fe9366dd58b47c9b29ba98bd3fc8d">dirDelete</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &)> const &)</td></tr>
|
|
<tr class="memdesc:a469fe9366dd58b47c9b29ba98bd3fc8d"><td class="mdescLeft"> </td><td class="mdescRight">Remove the specified directory, invoking the callback for every node. <a href="classripple_1_1ApplyView.html#a469fe9366dd58b47c9b29ba98bd3fc8d">More...</a><br /></td></tr>
|
|
<tr class="separator:a469fe9366dd58b47c9b29ba98bd3fc8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68f2bcf1204498ac968947005ef9c3de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a68f2bcf1204498ac968947005ef9c3de">emptyDirDelete</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory)</td></tr>
|
|
<tr class="memdesc:a68f2bcf1204498ac968947005ef9c3de"><td class="mdescLeft"> </td><td class="mdescRight">Remove the specified directory, if it is empty. <a href="classripple_1_1ApplyView.html#a68f2bcf1204498ac968947005ef9c3de">More...</a><br /></td></tr>
|
|
<tr class="separator:a68f2bcf1204498ac968947005ef9c3de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca9d5e022d68fdd94bf3c8e36a294a96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#aca9d5e022d68fdd94bf3c8e36a294a96">info</a> () const =0</td></tr>
|
|
<tr class="memdesc:aca9d5e022d68fdd94bf3c8e36a294a96"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about the ledger. <a href="classripple_1_1ReadView.html#aca9d5e022d68fdd94bf3c8e36a294a96">More...</a><br /></td></tr>
|
|
<tr class="separator:aca9d5e022d68fdd94bf3c8e36a294a96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a8dc63ee1e4ae7b2f96823e146c53d03e">open</a> () const =0</td></tr>
|
|
<tr class="memdesc:a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this reflects an open ledger. <a href="classripple_1_1ReadView.html#a8dc63ee1e4ae7b2f96823e146c53d03e">More...</a><br /></td></tr>
|
|
<tr class="separator:a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a1427aa6cbbda99c50b9ca0ebf6e0d0b3">parentCloseTime</a> () const</td></tr>
|
|
<tr class="memdesc:a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the close time of the previous ledger. <a href="classripple_1_1ReadView.html#a1427aa6cbbda99c50b9ca0ebf6e0d0b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac284afc905c482953c35c61b459fd85b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ac284afc905c482953c35c61b459fd85b">seq</a> () const</td></tr>
|
|
<tr class="memdesc:ac284afc905c482953c35c61b459fd85b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the sequence number of the base ledger. <a href="classripple_1_1ReadView.html#ac284afc905c482953c35c61b459fd85b">More...</a><br /></td></tr>
|
|
<tr class="separator:ac284afc905c482953c35c61b459fd85b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9944284a00f671a4a9d9e00f9b28b258"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structripple_1_1Fees.html">Fees</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a9944284a00f671a4a9d9e00f9b28b258">fees</a> () const =0</td></tr>
|
|
<tr class="memdesc:a9944284a00f671a4a9d9e00f9b28b258"><td class="mdescLeft"> </td><td class="mdescRight">Returns the fees for the base ledger. <a href="classripple_1_1ReadView.html#a9944284a00f671a4a9d9e00f9b28b258">More...</a><br /></td></tr>
|
|
<tr class="separator:a9944284a00f671a4a9d9e00f9b28b258"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceb3d74acaae18b238022337e5f250ce"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1Rules.html">Rules</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#aceb3d74acaae18b238022337e5f250ce">rules</a> () const =0</td></tr>
|
|
<tr class="memdesc:aceb3d74acaae18b238022337e5f250ce"><td class="mdescLeft"> </td><td class="mdescRight">Returns the tx processing rules. <a href="classripple_1_1ReadView.html#aceb3d74acaae18b238022337e5f250ce">More...</a><br /></td></tr>
|
|
<tr class="separator:aceb3d74acaae18b238022337e5f250ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1d377c35a8332d069b09be8f4008dec"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ac1d377c35a8332d069b09be8f4008dec">exists</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &k) const =0</td></tr>
|
|
<tr class="memdesc:ac1d377c35a8332d069b09be8f4008dec"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a state item exists. <a href="classripple_1_1ReadView.html#ac1d377c35a8332d069b09be8f4008dec">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1d377c35a8332d069b09be8f4008dec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15b3629cee45ef3f5af4cef06f42e54a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a15b3629cee45ef3f5af4cef06f42e54a">succ</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > const &last=std::nullopt) const =0</td></tr>
|
|
<tr class="memdesc:a15b3629cee45ef3f5af4cef06f42e54a"><td class="mdescLeft"> </td><td class="mdescRight">Return the key of the next state item. <a href="classripple_1_1ReadView.html#a15b3629cee45ef3f5af4cef06f42e54a">More...</a><br /></td></tr>
|
|
<tr class="separator:a15b3629cee45ef3f5af4cef06f42e54a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0583a050ea7799ba331f6222a905f304"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">read</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &k) const =0</td></tr>
|
|
<tr class="memdesc:a0583a050ea7799ba331f6222a905f304"><td class="mdescLeft"> </td><td class="mdescRight">Return the state item associated with a key. <a href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">More...</a><br /></td></tr>
|
|
<tr class="separator:a0583a050ea7799ba331f6222a905f304"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81e1b7628e44e758a0359061c4b17c96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1STAmount.html">STAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a81e1b7628e44e758a0359061c4b17c96">balanceHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &issuer, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount) const</td></tr>
|
|
<tr class="separator:a81e1b7628e44e758a0359061c4b17c96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6989ce9f6240d5c600d3a4f526f89d29"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a6989ce9f6240d5c600d3a4f526f89d29">ownerCountHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> count) const</td></tr>
|
|
<tr class="separator:a6989ce9f6240d5c600d3a4f526f89d29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae42d4f16315f6e357fbaf7157991470a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ae42d4f16315f6e357fbaf7157991470a">slesBegin</a> () const =0</td></tr>
|
|
<tr class="separator:ae42d4f16315f6e357fbaf7157991470a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ca795f655eb8b6b9ade9c1634e0ef17"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a4ca795f655eb8b6b9ade9c1634e0ef17">slesEnd</a> () const =0</td></tr>
|
|
<tr class="separator:a4ca795f655eb8b6b9ade9c1634e0ef17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1903bd286e89d517dcec9fcbef5e7e32"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a1903bd286e89d517dcec9fcbef5e7e32">slesUpperBound</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="separator:a1903bd286e89d517dcec9fcbef5e7e32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d146422823dc32b9e846be1ddc8f318"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< txs_type::iter_base > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a1d146422823dc32b9e846be1ddc8f318">txsBegin</a> () const =0</td></tr>
|
|
<tr class="separator:a1d146422823dc32b9e846be1ddc8f318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc67c7456b33e839513ef233845846d9"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< txs_type::iter_base > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#adc67c7456b33e839513ef233845846d9">txsEnd</a> () const =0</td></tr>
|
|
<tr class="separator:adc67c7456b33e839513ef233845846d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af95bff423d062ed89665e9f628972ece"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#af95bff423d062ed89665e9f628972ece">txExists</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="memdesc:af95bff423d062ed89665e9f628972ece"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if a tx exists in the tx map. <a href="classripple_1_1ReadView.html#af95bff423d062ed89665e9f628972ece">More...</a><br /></td></tr>
|
|
<tr class="separator:af95bff423d062ed89665e9f628972ece"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af88b035a71531a9b27ee2fa25d0444e9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#af88b035a71531a9b27ee2fa25d0444e9">txRead</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="memdesc:af88b035a71531a9b27ee2fa25d0444e9"><td class="mdescLeft"> </td><td class="mdescRight">Read a transaction from the tx map. <a href="classripple_1_1ReadView.html#af88b035a71531a9b27ee2fa25d0444e9">More...</a><br /></td></tr>
|
|
<tr class="separator:af88b035a71531a9b27ee2fa25d0444e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:a542437b9b59a623e755979acdc075af5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a542437b9b59a623e755979acdc075af5">update</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &sle)=0</td></tr>
|
|
<tr class="memdesc:a542437b9b59a623e755979acdc075af5"><td class="mdescLeft"> </td><td class="mdescRight">Indicate changes to a peeked SLE. <a href="classripple_1_1ApplyView.html#a542437b9b59a623e755979acdc075af5">More...</a><br /></td></tr>
|
|
<tr class="separator:a542437b9b59a623e755979acdc075af5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fbccbab01154b3918eba1131eb6a603"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a2fbccbab01154b3918eba1131eb6a603">creditHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &from, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &to, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &preCreditBalance)</td></tr>
|
|
<tr class="separator:a2fbccbab01154b3918eba1131eb6a603"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a876b5aa9b60e7579b187afe05fd3b8d1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a876b5aa9b60e7579b187afe05fd3b8d1">adjustOwnerCountHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> cur, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> next)</td></tr>
|
|
<tr class="separator:a876b5aa9b60e7579b187afe05fd3b8d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dc52893f14495b06de08265f6e1e45a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a6dc52893f14495b06de08265f6e1e45a">dirAppend</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const &describe)</td></tr>
|
|
<tr class="memdesc:a6dc52893f14495b06de08265f6e1e45a"><td class="mdescLeft"> </td><td class="mdescRight">Append an entry to a directory. <a href="classripple_1_1ApplyView.html#a6dc52893f14495b06de08265f6e1e45a">More...</a><br /></td></tr>
|
|
<tr class="separator:a6dc52893f14495b06de08265f6e1e45a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:ae21b78e549dc6188382bd49e7d77d473"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#ae21b78e549dc6188382bd49e7d77d473">dirInsert</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const &describe)</td></tr>
|
|
<tr class="memdesc:ae21b78e549dc6188382bd49e7d77d473"><td class="mdescLeft"> </td><td class="mdescRight">Insert an entry to a directory. <a href="classripple_1_1ApplyView.html#ae21b78e549dc6188382bd49e7d77d473">More...</a><br /></td></tr>
|
|
<tr class="separator:ae21b78e549dc6188382bd49e7d77d473"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fdb7385a8f65ff2f093332406ccbadf"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a0fdb7385a8f65ff2f093332406ccbadf">dirInsert</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const &describe)</td></tr>
|
|
<tr class="separator:a0fdb7385a8f65ff2f093332406ccbadf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
|
|
<tr class="memitem:a5a06441ef4fdb9b7f6e51437ce4a959f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a5a06441ef4fdb9b7f6e51437ce4a959f">dirRemove</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> page, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &key, bool keepRoot)</td></tr>
|
|
<tr class="memdesc:a5a06441ef4fdb9b7f6e51437ce4a959f"><td class="mdescLeft"> </td><td class="mdescRight">Remove an entry from a directory. <a href="classripple_1_1ApplyView.html#a5a06441ef4fdb9b7f6e51437ce4a959f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5a06441ef4fdb9b7f6e51437ce4a959f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add05adf228213dde2bc48821c0f7cc75"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#add05adf228213dde2bc48821c0f7cc75">dirRemove</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> page, <a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &key, bool keepRoot)</td></tr>
|
|
<tr class="separator:add05adf228213dde2bc48821c0f7cc75"><td class="memSeparator" colspan="2"> </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:afd166083a5c60300819b4385d92e51cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1ReadView_1_1sles__type.html">sles_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#afd166083a5c60300819b4385d92e51cb">sles</a></td></tr>
|
|
<tr class="memdesc:afd166083a5c60300819b4385d92e51cb"><td class="mdescLeft"> </td><td class="mdescRight">Iterable range of ledger state items. <a href="classripple_1_1ReadView.html#afd166083a5c60300819b4385d92e51cb">More...</a><br /></td></tr>
|
|
<tr class="separator:afd166083a5c60300819b4385d92e51cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c70dc4b36e757ed6472b0aef460d858"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1ReadView_1_1txs__type.html">txs_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a5c70dc4b36e757ed6472b0aef460d858">txs</a></td></tr>
|
|
<tr class="separator:a5c70dc4b36e757ed6472b0aef460d858"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a94b3d125ad93f0015829ffd8b8be59d6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ApplyView.html#a94b3d125ad93f0015829ffd8b8be59d6">dirAdd</a> (bool preserveOrder, <a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &directory, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const &describe)</td></tr>
|
|
<tr class="memdesc:a94b3d125ad93f0015829ffd8b8be59d6"><td class="mdescLeft"> </td><td class="mdescRight">Add an entry to a directory using the specified insert strategy. <a href="classripple_1_1ApplyView.html#a94b3d125ad93f0015829ffd8b8be59d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a94b3d125ad93f0015829ffd8b8be59d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Writeable view to a ledger, for applying a transaction. </p>
|
|
<p >This refinement of <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a> provides an interface where the SLE can be "checked out" for modifications and put back in an updated or removed state. Also added is an interface to provide contextual information necessary to calculate the results of transaction processing, including the metadata if the view is later applied to the parent (using an interface in the derived class). The context info also includes values from the base ledger such as sequence number and the network time.</p>
|
|
<p >This allows implementations to journal changes made to the state items in a ledger, with the option to apply those changes to the base or discard the changes without affecting the base.</p>
|
|
<p >Typical usage is to call <a class="el" href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304" title="Return the state item associated with a key.">read()</a> for non-mutating operations.</p>
|
|
<p >For mutating operations the sequence is as follows:</p>
|
|
<p >Add a new value v.insert(sle);</p>
|
|
<p >Check out a value for modification sle = v.peek(k);</p>
|
|
<p >Indicate that changes were made v.update(sle)</p>
|
|
<p >Or, erase the value v.erase(sle)</p>
|
|
<p >The invariant is that insert, update, and erase may not be called with any SLE which belongs to different view. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8h_source.html#l00143">143</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ab1430dec61fd5ef9bf4a013aab558d71" name="ab1430dec61fd5ef9bf4a013aab558d71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1430dec61fd5ef9bf4a013aab558d71">◆ </a></span>tx_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">ripple::ReadView::tx_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1STTx.html">STTx</a> const>, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1STObject.html">STObject</a> const> ></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00054">54</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a937328125a7d62270f32b4e1555c5cdd" name="a937328125a7d62270f32b4e1555c5cdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a937328125a7d62270f32b4e1555c5cdd">◆ </a></span>key_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">ripple::ReadView::key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00057">57</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c7268164504d76bee886f296b15e814" name="a0c7268164504d76bee886f296b15e814"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c7268164504d76bee886f296b15e814">◆ </a></span>mapped_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#a0c7268164504d76bee886f296b15e814">ripple::ReadView::mapped_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00059">59</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a39cfbb5c7bf09c07ef0386c78b321b7e" name="a39cfbb5c7bf09c07ef0386c78b321b7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39cfbb5c7bf09c07ef0386c78b321b7e">◆ </a></span>ApplyView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::ApplyView::ApplyView </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a94b3d125ad93f0015829ffd8b8be59d6" name="a94b3d125ad93f0015829ffd8b8be59d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94b3d125ad93f0015829ffd8b8be59d6">◆ </a></span>dirAdd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > ripple::ApplyView::dirAdd </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>preserveOrder</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const & </td>
|
|
<td class="paramname"><em>describe</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>Add an entry to a directory using the specified insert strategy. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8cpp_source.html#l00029">29</a> of file <a class="el" href="ApplyView_8cpp_source.html">ApplyView.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaed5d7cc6edfce1a9f88e50d65c876f1" name="aaed5d7cc6edfce1a9f88e50d65c876f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaed5d7cc6edfce1a9f88e50d65c876f1">◆ </a></span>flags()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> ripple::ApplyView::flags </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">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the tx apply flags. </p>
|
|
<p >Flags can affect the outcome of transaction processing. For example, transactions applied to an open ledger generate "local" failures, while transactions applied to the consensus ledger produce hard failures (and claim a fee). </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#ad615aed650814602031c446241bbca10">ripple::detail::ApplyViewBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa666aaa8eb0080d96f910f8a719291d" name="afa666aaa8eb0080d96f910f8a719291d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa666aaa8eb0080d96f910f8a719291d">◆ </a></span>peek()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > ripple::ApplyView::peek </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Prepare to modify the SLE associated with key. </p>
|
|
<p >Effects: </p><pre class="fragment">Gives the caller ownership of a modifiable
|
|
SLE associated with the specified key.
|
|
</pre><p> The returned SLE may be used in a subsequent call to erase or update.</p>
|
|
<p >The SLE must not be passed to any other <a class="el" href="classripple_1_1ApplyView.html" title="Writeable view to a ledger, for applying a transaction.">ApplyView</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>nullptr</code> if the key is not present </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#afe88196d7aec85f2af00d7cd0b1a28c3">ripple::detail::ApplyViewBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afda9c12acbda605becf20f54d45587d4" name="afda9c12acbda605becf20f54d45587d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afda9c12acbda605becf20f54d45587d4">◆ </a></span>erase()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::ApplyView::erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const & </td>
|
|
<td class="paramname"><em>sle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove a peeked SLE. </p>
|
|
<p >Requirements: </p><pre class="fragment">`sle` was obtained from prior call to peek()
|
|
on this instance of the RawView.
|
|
</pre><p> Effects: </p><pre class="fragment">The key is no longer associated with the SLE.
|
|
</pre>
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a165c96d3bf59c98b608ffabcf2f70276">ripple::detail::ApplyViewBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3c5b5cd9dca5f906be4b36640706e3c" name="aa3c5b5cd9dca5f906be4b36640706e3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3c5b5cd9dca5f906be4b36640706e3c">◆ </a></span>insert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::ApplyView::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const & </td>
|
|
<td class="paramname"><em>sle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Insert a new state SLE. </p>
|
|
<p >Requirements: </p><pre class="fragment">`sle` was not obtained from any calls to
|
|
peek() on any instances of RawView.
|
|
|
|
The SLE's key must not already exist.
|
|
</pre><p> Effects: </p><pre class="fragment">The key in the state map is associated
|
|
with the SLE.
|
|
|
|
The RawView acquires ownership of the shared_ptr.
|
|
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a669490ced7bb2cab3a6cc704bc7286df">ripple::detail::ApplyViewBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a542437b9b59a623e755979acdc075af5" name="a542437b9b59a623e755979acdc075af5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a542437b9b59a623e755979acdc075af5">◆ </a></span>update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::ApplyView::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const & </td>
|
|
<td class="paramname"><em>sle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Indicate changes to a peeked SLE. </p>
|
|
<p >Requirements: </p><pre class="fragment">The SLE's key must exist.
|
|
|
|
`sle` was obtained from prior call to peek()
|
|
on this instance of the RawView.
|
|
</pre><p> Effects: </p><pre class="fragment">The SLE is updated
|
|
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a4f12513f46ee2c194d6fb0e4d28e5543">ripple::detail::ApplyViewBase</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2fbccbab01154b3918eba1131eb6a603" name="a2fbccbab01154b3918eba1131eb6a603"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fbccbab01154b3918eba1131eb6a603">◆ </a></span>creditHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::ApplyView::creditHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>from</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>to</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>preCreditBalance</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#a651f7b9013b9de728969272c3b1e8712">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8h_source.html#l00244">244</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a876b5aa9b60e7579b187afe05fd3b8d1" name="a876b5aa9b60e7579b187afe05fd3b8d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a876b5aa9b60e7579b187afe05fd3b8d1">◆ </a></span>adjustOwnerCountHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void ripple::ApplyView::adjustOwnerCountHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>cur</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>next</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#abab734ed913c11e2dbca4b1d33634535">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8h_source.html#l00255">255</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dc52893f14495b06de08265f6e1e45a" name="a6dc52893f14495b06de08265f6e1e45a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dc52893f14495b06de08265f6e1e45a">◆ </a></span>dirAppend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > ripple::ApplyView::dirAppend </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const & </td>
|
|
<td class="paramname"><em>describe</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Append an entry to a directory. </p>
|
|
<p >Entries in the directory will be stored in order of insertion, i.e. new entries will always be added at the tail end of the last page.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">directory</td><td>the base of the directory </td></tr>
|
|
<tr><td class="paramname">key</td><td>the entry to insert </td></tr>
|
|
<tr><td class="paramname">describe</td><td>callback to add required entries to a new page</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a <code><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></code> which, if insertion was successful, will contain the page number in which the item was stored.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>this function may create a page (including a root page), if no page with space is available. This function will only fail if the page counter exceeds the protocol-defined maximum number of allowable pages. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8h_source.html#l00281">281</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae21b78e549dc6188382bd49e7d77d473" name="ae21b78e549dc6188382bd49e7d77d473"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae21b78e549dc6188382bd49e7d77d473">◆ </a></span>dirInsert() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > ripple::ApplyView::dirInsert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const & </td>
|
|
<td class="paramname"><em>describe</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Insert an entry to a directory. </p>
|
|
<p >Entries in the directory will be stored in a semi-random order, but each page will be maintained in sorted order.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">directory</td><td>the base of the directory </td></tr>
|
|
<tr><td class="paramname">key</td><td>the entry to insert </td></tr>
|
|
<tr><td class="paramname">describe</td><td>callback to add required entries to a new page</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a <code><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></code> which, if insertion was successful, will contain the page number in which the item was stored.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>this function may create a page (including a root page), if no page with space is available.this function will only fail if the page counter exceeds the protocol-defined maximum number of allowable pages. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8h_source.html#l00318">318</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0fdb7385a8f65ff2f093332406ccbadf" name="a0fdb7385a8f65ff2f093332406ccbadf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fdb7385a8f65ff2f093332406ccbadf">◆ </a></span>dirInsert() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> > ripple::ApplyView::dirInsert </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> > const &)> const & </td>
|
|
<td class="paramname"><em>describe</em> </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="ApplyView_8h_source.html#l00327">327</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a06441ef4fdb9b7f6e51437ce4a959f" name="a5a06441ef4fdb9b7f6e51437ce4a959f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a06441ef4fdb9b7f6e51437ce4a959f">◆ </a></span>dirRemove() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ApplyView::dirRemove </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> </td>
|
|
<td class="paramname"><em>page</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>keepRoot</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove an entry from a directory. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">directory</td><td>the base of the directory </td></tr>
|
|
<tr><td class="paramname">page</td><td>the page number for this page </td></tr>
|
|
<tr><td class="paramname">key</td><td>the entry to remove </td></tr>
|
|
<tr><td class="paramname">keepRoot</td><td>if deleting the last entry, don't delete the root page (i.e. the directory itself).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the entry was found and deleted and <code>false</code> otherwise.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This function will remove zero or more pages from the directory; the root page will not be deleted even if it is empty, unless <code>keepRoot</code> is not set and the directory is empty. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8cpp_source.html#l00190">190</a> of file <a class="el" href="ApplyView_8cpp_source.html">ApplyView.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add05adf228213dde2bc48821c0f7cc75" name="add05adf228213dde2bc48821c0f7cc75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add05adf228213dde2bc48821c0f7cc75">◆ </a></span>dirRemove() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ApplyView::dirRemove </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> </td>
|
|
<td class="paramname"><em>page</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>keepRoot</em> </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="ApplyView_8h_source.html#l00360">360</a> of file <a class="el" href="ApplyView_8h_source.html">ApplyView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a469fe9366dd58b47c9b29ba98bd3fc8d" name="a469fe9366dd58b47c9b29ba98bd3fc8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a469fe9366dd58b47c9b29ba98bd3fc8d">◆ </a></span>dirDelete()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ApplyView::dirDelete </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< void(<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &)> const & </td>
|
|
<td class="paramname"><em>callback</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove the specified directory, invoking the callback for every node. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8cpp_source.html#l00339">339</a> of file <a class="el" href="ApplyView_8cpp_source.html">ApplyView.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68f2bcf1204498ac968947005ef9c3de" name="a68f2bcf1204498ac968947005ef9c3de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68f2bcf1204498ac968947005ef9c3de">◆ </a></span>emptyDirDelete()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ApplyView::emptyDirDelete </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>directory</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove the specified directory, if it is empty. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">directory</td><td>the identifier of the directory node to be deleted </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the directory was found and was successfully deleted <code>false</code> otherwise.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>The function should only be called with the root entry (i.e. with the first page) of a directory. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ApplyView_8cpp_source.html#l00126">126</a> of file <a class="el" href="ApplyView_8cpp_source.html">ApplyView.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aca9d5e022d68fdd94bf3c8e36a294a96" name="aca9d5e022d68fdd94bf3c8e36a294a96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca9d5e022d68fdd94bf3c8e36a294a96">◆ </a></span>info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> const & ripple::ReadView::info </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns information about the ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a008804ecb39a09e9e0cc906044bcc64c">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a670216d23345c14bc5c1cb055b81aea2">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a6ce0efb30729b08c4794b00a51e59aa5">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a3cfed3b0da284339dcdd02b50dcafa6f">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8dc63ee1e4ae7b2f96823e146c53d03e" name="a8dc63ee1e4ae7b2f96823e146c53d03e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8dc63ee1e4ae7b2f96823e146c53d03e">◆ </a></span>open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::open </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if this reflects an open ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a131fb72a0a470e6b493865f9a06762c4">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#afb1c7f57990c69df15950a4d83babc4c">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a4af2aa917f94d3f031d8e53c3211f9e1">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#aea54a965aa77bcd1f3cdb34c24176cb6">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1427aa6cbbda99c50b9ca0ebf6e0d0b3" name="a1427aa6cbbda99c50b9ca0ebf6e0d0b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1427aa6cbbda99c50b9ca0ebf6e0d0b3">◆ </a></span>parentCloseTime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> ripple::ReadView::parentCloseTime </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">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the close time of the previous ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00112">112</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac284afc905c482953c35c61b459fd85b" name="ac284afc905c482953c35c61b459fd85b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac284afc905c482953c35c61b459fd85b">◆ </a></span>seq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::ReadView::seq </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">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the sequence number of the base ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00119">119</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9944284a00f671a4a9d9e00f9b28b258" name="a9944284a00f671a4a9d9e00f9b28b258"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9944284a00f671a4a9d9e00f9b28b258">◆ </a></span>fees()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="structripple_1_1Fees.html">Fees</a> const & ripple::ReadView::fees </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the fees for the base ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a69a7d74ebc864270b4d4f636c539f78d">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#aeda7788af08abf38fbd3e156db58faf3">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a08bb2668a3260801e8f7d85b4242eb6c">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#af5f70f90ab27cd12ed017a4e1d2494b1">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aceb3d74acaae18b238022337e5f250ce" name="aceb3d74acaae18b238022337e5f250ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aceb3d74acaae18b238022337e5f250ce">◆ </a></span>rules()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1Rules.html">Rules</a> const & ripple::ReadView::rules </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the tx processing rules. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a9e498a76456a43e4a021e47c35adad5e">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#ae09b56129812843907916ceea46a78d2">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#af16244cf2efd903b4575a0b85c94d159">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a9b6ad540708bc720bdd66164078e640a">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1d377c35a8332d069b09be8f4008dec" name="ac1d377c35a8332d069b09be8f4008dec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1d377c35a8332d069b09be8f4008dec">◆ </a></span>exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine if a state item exists. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This can be more efficient than calling read.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a SLE is associated with the specified key. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a196e844a1c5a015af934bd864690a1e2">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a68bb9ce15af8016d45d70129fb269078">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#ab5b90b656223e19272dfe10e2dcd7f56">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a8b67b4e594ed8c96dfcf0d5dc895d0a2">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15b3629cee45ef3f5af4cef06f42e54a" name="a15b3629cee45ef3f5af4cef06f42e54a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15b3629cee45ef3f5af4cef06f42e54a">◆ </a></span>succ()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > ripple::ReadView::succ </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > const & </td>
|
|
<td class="paramname"><em>last</em> = <code>std::nullopt</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the key of the next state item. </p>
|
|
<p >This returns the key of the first state item whose key is greater than the specified key. If no such key is present, std::nullopt is returned.</p>
|
|
<p >If <code>last</code> is engaged, returns std::nullopt when the key returned would be outside the open interval (key, last). </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a875950bc040b2704243d0a6ac9107ed4">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#abb4191e08ea906c3074d4020ad6c8fde">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a76b4e313ced46f6caaff0b53da2298bb">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0583a050ea7799ba331f6222a905f304" name="a0583a050ea7799ba331f6222a905f304"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0583a050ea7799ba331f6222a905f304">◆ </a></span>read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const > ripple::ReadView::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the state item associated with a key. </p>
|
|
<p >Effects: If the key exists, gives the caller ownership of the non-modifiable corresponding SLE.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>While the returned SLE is <code>const</code> from the perspective of the caller, it can be changed by other callers through raw operations.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>nullptr</code> if the key is not present or if the type does not match. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a945ead8d34dfdb0a2b01ae3125afa8eb">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a582680a14129f2d3e08018a3044a0b4b">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#adbca64f4c123b0fbcfdf27586649732b">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a9db14117eadad3eefc95f1b584ecda8d">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81e1b7628e44e758a0359061c4b17c96" name="a81e1b7628e44e758a0359061c4b17c96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81e1b7628e44e758a0359061c4b17c96">◆ </a></span>balanceHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1STAmount.html">STAmount</a> ripple::ReadView::balanceHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>issuer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#a96457b37722d895c585bcd260dd08a0f">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00179">179</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6989ce9f6240d5c600d3a4f526f89d29" name="a6989ce9f6240d5c600d3a4f526f89d29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6989ce9f6240d5c600d3a4f526f89d29">◆ </a></span>ownerCountHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::ReadView::ownerCountHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#a0e77b6bdc540075e1c8e5a6f447c4b13">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00193">193</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae42d4f16315f6e357fbaf7157991470a" name="ae42d4f16315f6e357fbaf7157991470a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae42d4f16315f6e357fbaf7157991470a">◆ </a></span>slesBegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > ripple::ReadView::slesBegin </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#aa83dfb46c969cf85cba5ca889b5cf7d6">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a92207fdd1c5a69fafd770f23e4355fb7">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a84a5864b69739165cd7d711a49a457c1">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#aa8f657e95982e0f69f5b1476119ad76f">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ca795f655eb8b6b9ade9c1634e0ef17" name="a4ca795f655eb8b6b9ade9c1634e0ef17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ca795f655eb8b6b9ade9c1634e0ef17">◆ </a></span>slesEnd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > ripple::ReadView::slesEnd </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a220660a0e999b374e502b117ae93833f">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#ac6183b176e9072137a45972a748914ac">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a69dc208d6b5afb41607fde91bcabc018">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a5dff0c0a73e494964e1f2e30cec4181e">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1903bd286e89d517dcec9fcbef5e7e32" name="a1903bd286e89d517dcec9fcbef5e7e32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1903bd286e89d517dcec9fcbef5e7e32">◆ </a></span>slesUpperBound()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< sles_type::iter_base > ripple::ReadView::slesUpperBound </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d146422823dc32b9e846be1ddc8f318" name="a1d146422823dc32b9e846be1ddc8f318"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d146422823dc32b9e846be1ddc8f318">◆ </a></span>txsBegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< txs_type::iter_base > ripple::ReadView::txsBegin </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#ad0ae3a298b1fc8b7b45524f86fed514f">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a753ef4b364431985f504669c8fc142cc">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a960d0fe7b6a20c4bbc4041830eb77a54">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#af5368511bd160054aaeaa9ca6145951c">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adc67c7456b33e839513ef233845846d9" name="adc67c7456b33e839513ef233845846d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc67c7456b33e839513ef233845846d9">◆ </a></span>txsEnd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< txs_type::iter_base > ripple::ReadView::txsEnd </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#acaf4d523fa7525606f7b1e576cf048c5">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a1b008fe9cb5458491e009407f803bf9a">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a239ae0136ad4bf2b6d71e4bb195941b6">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#af8d49b5de0ac18aa287d057daa594f0f">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af95bff423d062ed89665e9f628972ece" name="af95bff423d062ed89665e9f628972ece"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af95bff423d062ed89665e9f628972ece">◆ </a></span>txExists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::txExists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if a tx exists in the tx map. </p>
|
|
<p >A tx exists in the map if it is part of the base ledger, or if it is a newly inserted tx. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a5315d4aaf5a02b646e44cbc28cfca9ec">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#ad7cd53575d79dd8f0bf93a0143957b9d">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a2294a6339fc789d88ca4b155a493c71a">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af88b035a71531a9b27ee2fa25d0444e9" name="af88b035a71531a9b27ee2fa25d0444e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af88b035a71531a9b27ee2fa25d0444e9">◆ </a></span>txRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> ripple::ReadView::txRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a transaction from the tx map. </p>
|
|
<p >If the view represents an open ledger, the metadata object will be empty.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pair of nullptr if the key is not found in the tx map. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1Ledger.html#a6cf0862134638e77b99e53c25c41f3a9">ripple::Ledger</a>, <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a27043f0ad97acde4fc0e2fc6103d4f85">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a7da423c0d9af7e21383bffd56059aba3">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a16e0ecf8af65a3d89350dcfdb77ea1d1">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="afd166083a5c60300819b4385d92e51cb" name="afd166083a5c60300819b4385d92e51cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd166083a5c60300819b4385d92e51cb">◆ </a></span>sles</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1ReadView_1_1sles__type.html">sles_type</a> ripple::ReadView::sles</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterable range of ledger state items. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Visiting each state entry in the ledger can become quite expensive as the ledger grows. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00246">246</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c70dc4b36e757ed6472b0aef460d858" name="a5c70dc4b36e757ed6472b0aef460d858"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c70dc4b36e757ed6472b0aef460d858">◆ </a></span>txs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1ReadView_1_1txs__type.html">txs_type</a> ripple::ReadView::txs</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00249">249</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|