Files
rippled/STAccount_8cpp_source.html
2020-04-24 01:09:47 +00:00

170 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: STAccount.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li><li class="navelem"><a class="el" href="dir_41c387a0f328eeb295307369675c1162.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">STAccount.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/STAccount.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstring.html">cstring</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1"> 26</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">STAccount::STAccount</a>() : <a class="code" href="classripple_1_1STBase.html">STBase</a>(), value_(<a class="code" href="namespacebeast.html">beast</a>::zero), default_(true)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;}</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#a97828882cca1633b2c2536103d462723"> 30</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">STAccount::STAccount</a>(<a class="code" href="classripple_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; n)</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; : <a class="code" href="classripple_1_1STBase.html">STBase</a>(n), value_(<a class="code" href="namespacebeast.html">beast</a>::zero), default_(true)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#abe5243edbda69b11a83b694b38290550"> 35</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">STAccount::STAccount</a>(<a class="code" href="classripple_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; n, <a class="code" href="classripple_1_1Buffer.html">Buffer</a>&amp;&amp; v) : <a class="code" href="classripple_1_1STAccount.html">STAccount</a>(n)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> (v.empty())</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span>; <span class="comment">// Zero is a valid size for a defaulted STAccount.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// Is it safe to throw from this constructor? Today (November 2015)</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// the only place that calls this constructor is</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// STVar::STVar (SerialIter&amp;, SField const&amp;)</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// which throws. If STVar can throw in its constructor, then so can</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="comment">// STAccount.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">if</span> (v.size() != <a class="code" href="classripple_1_1base__uint.html#a4b9e8d36a37963d48be8f081d99257bf">uint160::bytes</a>)</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;Invalid STAccount size&quot;</span>);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="classripple_1_1STAccount.html#a2a7e531fc7711446583e1b03fd004717">default_</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; memcpy(<a class="code" href="classripple_1_1STAccount.html#acb8ef45428c24081e10fde6c4d215ee9">value_</a>.<a class="code" href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">begin</a>(), v.data(), <a class="code" href="classripple_1_1base__uint.html#a4b9e8d36a37963d48be8f081d99257bf">uint160::bytes</a>);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;}</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#a0c00b25528160850c747b9d1bfe73d97"> 52</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">STAccount::STAccount</a>(<a class="code" href="classripple_1_1SerialIter.html">SerialIter</a>&amp; sit, <a class="code" href="classripple_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; name)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; : <a class="code" href="classripple_1_1STAccount.html">STAccount</a>(name, sit.getVLBuffer())</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#a7f6262413e5d2921e3fba8c9f2916f8a"> 57</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">STAccount::STAccount</a>(<a class="code" href="classripple_1_1SField.html">SField</a> <span class="keyword">const</span>&amp; n, <a class="code" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; v)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; : <a class="code" href="classripple_1_1STBase.html">STBase</a>(n), value_(v), default_(false)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classripple_1_1STAccount.html#acb11dfe2525152d1e4df96659c2121f1"> 63</a></span>&#160;<a class="code" href="classripple_1_1STAccount.html#acb11dfe2525152d1e4df96659c2121f1">STAccount::getText</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1STAccount.html#ac74afdb795ee7865dd21285933450738">isDefault</a>())</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceripple.html#a08a13b62b18272366f788632359e8793">toBase58</a>(<a class="code" href="classripple_1_1STAccount.html#a18a0662c97131c7284efc8a05bd8e6d5">value</a>());</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="acstring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstring.html">cstring</a></div></div>
<div class="ttc" id="anamespaceripple_html_a08a13b62b18272366f788632359e8793"><div class="ttname"><a href="namespaceripple.html#a08a13b62b18272366f788632359e8793">ripple::toBase58</a></div><div class="ttdeci">std::string toBase58(AccountID const &amp;v)</div><div class="ttdoc">Convert AccountID to base58 checked string.</div><div class="ttdef"><b>Definition:</b> <a href="AccountID_8cpp_source.html#l00029">AccountID.cpp:29</a></div></div>
<div class="ttc" id="aclassripple_1_1Buffer_html"><div class="ttname"><a href="classripple_1_1Buffer.html">ripple::Buffer</a></div><div class="ttdoc">Like std::vector&lt;char&gt; but better.</div><div class="ttdef"><b>Definition:</b> <a href="Buffer_8h_source.html#l00035">Buffer.h:35</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_ac74afdb795ee7865dd21285933450738"><div class="ttname"><a href="classripple_1_1STAccount.html#ac74afdb795ee7865dd21285933450738">ripple::STAccount::isDefault</a></div><div class="ttdeci">bool isDefault() const override</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8h_source.html#l00090">STAccount.h:90</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_a0c15b06cda2c25fb2ec5c2d2cdd048a1"><div class="ttname"><a href="classripple_1_1STAccount.html#a0c15b06cda2c25fb2ec5c2d2cdd048a1">ripple::STAccount::STAccount</a></div><div class="ttdeci">STAccount()</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8cpp_source.html#l00026">STAccount.cpp:26</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_a2a7e531fc7711446583e1b03fd004717"><div class="ttname"><a href="classripple_1_1STAccount.html#a2a7e531fc7711446583e1b03fd004717">ripple::STAccount::default_</a></div><div class="ttdeci">bool default_</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8h_source.html#l00037">STAccount.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html_a4b9e8d36a37963d48be8f081d99257bf"><div class="ttname"><a href="classripple_1_1base__uint.html#a4b9e8d36a37963d48be8f081d99257bf">ripple::base_uint::bytes</a></div><div class="ttdeci">static constexpr std::size_t bytes</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00086">base_uint.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_acb8ef45428c24081e10fde6c4d215ee9"><div class="ttname"><a href="classripple_1_1STAccount.html#acb8ef45428c24081e10fde6c4d215ee9">ripple::STAccount::value_</a></div><div class="ttdeci">AccountID value_</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8h_source.html#l00036">STAccount.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1SerialIter_html"><div class="ttname"><a href="classripple_1_1SerialIter.html">ripple::SerialIter</a></div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00368">Serializer.h:368</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_a18a0662c97131c7284efc8a05bd8e6d5"><div class="ttname"><a href="classripple_1_1STAccount.html#a18a0662c97131c7284efc8a05bd8e6d5">ripple::STAccount::value</a></div><div class="ttdeci">AccountID value() const noexcept</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8h_source.html#l00103">STAccount.h:103</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html"><div class="ttname"><a href="classripple_1_1STAccount.html">ripple::STAccount</a></div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8h_source.html#l00029">STAccount.h:29</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html_a2ffd09234d574e5554c5d84199a9f287"><div class="ttname"><a href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">ripple::base_uint::begin</a></div><div class="ttdeci">iterator begin()</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00114">base_uint.h:114</a></div></div>
<div class="ttc" id="aclassripple_1_1STAccount_html_acb11dfe2525152d1e4df96659c2121f1"><div class="ttname"><a href="classripple_1_1STAccount.html#acb11dfe2525152d1e4df96659c2121f1">ripple::STAccount::getText</a></div><div class="ttdeci">std::string getText() const override</div><div class="ttdef"><b>Definition:</b> <a href="STAccount_8cpp_source.html#l00063">STAccount.cpp:63</a></div></div>
<div class="ttc" id="aclassripple_1_1SField_html"><div class="ttname"><a href="classripple_1_1SField.html">ripple::SField</a></div><div class="ttdoc">Identifies fields.</div><div class="ttdef"><b>Definition:</b> <a href="SField_8h_source.html#l00109">SField.h:109</a></div></div>
<div class="ttc" id="aclassripple_1_1STBase_html"><div class="ttname"><a href="classripple_1_1STBase.html">ripple::STBase</a></div><div class="ttdoc">A type which can be exported to a well known binary format.</div><div class="ttdef"><b>Definition:</b> <a href="STBase_8h_source.html#l00062">STBase.h:62</a></div></div>
<div class="ttc" id="anamespacebeast_html"><div class="ttname"><a href="namespacebeast.html">beast</a></div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00646">base_uint.h:646</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>