ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 19:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b7f5072ca11eb25c8b98a3c6986e6bd6b6dbaf51
rippled/KnownFormats_8h_source.html
carlhua b7f5072ca1 deploy: e1a2939f89
2020-09-22 22:46:01 +00:00

264 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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: KnownFormats.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">KnownFormats.h</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">#ifndef RIPPLE_PROTOCOL_KNOWNFORMATS_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_PROTOCOL_KNOWNFORMATS_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/basics/contract.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/SOTemplate.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;boost/container/flat_map.hpp&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/forward_list.html">forward_list</a>&gt;</span></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;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> KeyType&gt;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html"> 39</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1KnownFormats.html">KnownFormats</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;{</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html"> 44</a></span>&#160; <span class="keyword">class </span><a class="code" href="classripple_1_1KnownFormats_1_1Item.html">Item</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#abfb0c207121d265f657d487ee1853f95"> 47</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#abfb0c207121d265f657d487ee1853f95">Item</a>(</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">char</span> <span class="keyword">const</span>* name,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list&lt;SOElement&gt;</a> uniqueFields,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list&lt;SOElement&gt;</a> commonFields)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; : <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a504752f8ad1fa863036283aad1426914">soTemplate_</a>(uniqueFields, commonFields), <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a04d9fe5392d260b25fd5b1ac14fb6df5">name_</a>(name), <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a139c2cc44f47b650ccc6c4cf8665a247">type_</a>(type)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Verify that KeyType is appropriate.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; static_assert(</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/is_enum.html">std::is_enum&lt;KeyType&gt;::value</a> ||</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral&lt;KeyType&gt;::value</a>,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="stringliteral">&quot;KnownFormats KeyType must be integral or enum.&quot;</span>);</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="l00063"></a><span class="lineno"> 63</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#ab33786d750b089c62ec6d4b2a1f3365b"> 64</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#ab33786d750b089c62ec6d4b2a1f3365b">getName</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a04d9fe5392d260b25fd5b1ac14fb6df5">name_</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#a4ea6608597737091d083001f02a1634a"> 72</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a4ea6608597737091d083001f02a1634a">getType</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a139c2cc44f47b650ccc6c4cf8665a247">type_</a>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classripple_1_1SOTemplate.html">SOTemplate</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#ab75ce40a274a032c312bae5bacb8e087"> 78</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#ab75ce40a274a032c312bae5bacb8e087">getSOTemplate</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a504752f8ad1fa863036283aad1426914">soTemplate_</a>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#a504752f8ad1fa863036283aad1426914"> 84</a></span>&#160; <a class="code" href="classripple_1_1SOTemplate.html">SOTemplate</a> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a504752f8ad1fa863036283aad1426914">soTemplate_</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#a04d9fe5392d260b25fd5b1ac14fb6df5"> 85</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a04d9fe5392d260b25fd5b1ac14fb6df5">name_</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats_1_1Item.html#a139c2cc44f47b650ccc6c4cf8665a247"> 86</a></span>&#160; <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> <span class="keyword">const</span> <a class="code" href="classripple_1_1KnownFormats_1_1Item.html#a139c2cc44f47b650ccc6c4cf8665a247">type_</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a61870a3c657db7800ccf911166294a48">KnownFormats</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classripple_1_1KnownFormats.html#a69662755c4d487308e7a4a79811349e3">~KnownFormats</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a61870a3c657db7800ccf911166294a48">KnownFormats</a>(<a class="code" href="classripple_1_1KnownFormats.html">KnownFormats</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html">KnownFormats</a>&amp;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#acc7de39aaa3558f967a3ece1bda382a0">operator=</a>(<a class="code" href="classripple_1_1KnownFormats.html">KnownFormats</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a></div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a4acde7284e1f5aaa5489e12adca82deb"> 112</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a4acde7284e1f5aaa5489e12adca82deb">findTypeByName</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; Item <span class="keyword">const</span>* <span class="keyword">const</span> result = <a class="code" href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1">findByName</a>(name);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordflow">if</span> (result != <span class="keyword">nullptr</span>)</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">return</span> result-&gt;getType();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;Unknown format name&quot;</span>);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">return</span> {}; <span class="comment">// Silence compiler warning.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; }</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; Item <span class="keyword">const</span>*</div>
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#ab3a38712296e0e75e394baaa8a1b3211"> 125</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#ab3a38712296e0e75e394baaa8a1b3211">findByType</a>(<a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type)<span class="keyword"> const</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> itr = <a class="code" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">types_</a>.find(type);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">if</span> (itr == <a class="code" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">types_</a>.end())</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordflow">return</span> itr-&gt;second;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; }</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="comment">// begin() and end() are provided for testing purposes.</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keyword">typename</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/forward_list.html">std::forward_list&lt;Item&gt;::const_iterator</a></div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a1df800bc2f63ea614243b6e7a996e5b1"> 135</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a1df800bc2f63ea614243b6e7a996e5b1">begin</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a>.begin();</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; }</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keyword">typename</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/forward_list.html">std::forward_list&lt;Item&gt;::const_iterator</a></div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a856eadbc12d29b208d258ff3a83109aa"> 141</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a856eadbc12d29b208d258ff3a83109aa">end</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a>.end();</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; }</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; Item <span class="keyword">const</span>*</div>
<div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1"> 150</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1">findByName</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> itr = <a class="code" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">names_</a>.find(name);</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordflow">if</span> (itr == <a class="code" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">names_</a>.end())</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keywordflow">return</span> itr-&gt;second;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; }</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; Item <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60"> 168</a></span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">add</a>(<span class="keywordtype">char</span> <span class="keyword">const</span>* name,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <a class="code" href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">KeyType</a> type,</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list&lt;SOElement&gt;</a> uniqueFields,</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list&lt;SOElement&gt;</a> commonFields = {})</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; {</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a>.emplace_front(name, type, uniqueFields, commonFields);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; Item <span class="keyword">const</span>&amp; item{<a class="code" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a>.front()};</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">names_</a>[name] = &amp;item;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <a class="code" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">types_</a>[type] = &amp;item;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordflow">return</span> item;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; }</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="comment">// One of the situations where a std::forward_list is useful. We want to</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="comment">// store each Item in a place where its address won&#39;t change. So a node-</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <span class="comment">// based container is appropriate. But we don&#39;t need searchability.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3"> 186</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/forward_list.html">std::forward_list&lt;Item&gt;</a> <a class="code" href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">formats_</a>;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; </div>
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477"> 188</a></span>&#160; boost::container::flat_map&lt;std::string, Item const*&gt; <a class="code" href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">names_</a>;</div>
<div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d"> 189</a></span>&#160; boost::container::flat_map&lt;KeyType, Item const*&gt; <a class="code" href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">types_</a>;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;};</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; </div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a6a4136f7e69948157f5e2bdf5aa6cb60"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a6a4136f7e69948157f5e2bdf5aa6cb60">ripple::KnownFormats::add</a></div><div class="ttdeci">Item const &amp; add(char const *name, KeyType type, std::initializer_list&lt; SOElement &gt; uniqueFields, std::initializer_list&lt; SOElement &gt; commonFields={})</div><div class="ttdoc">Add a new format.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00168">KnownFormats.h:168</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a4acde7284e1f5aaa5489e12adca82deb"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a4acde7284e1f5aaa5489e12adca82deb">ripple::KnownFormats::findTypeByName</a></div><div class="ttdeci">KeyType findTypeByName(std::string const &amp;name) const</div><div class="ttdoc">Retrieve the type for a format specified by name.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00112">KnownFormats.h:112</a></div></div>
<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="aclassripple_1_1KnownFormats_1_1Item_html_ab33786d750b089c62ec6d4b2a1f3365b"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#ab33786d750b089c62ec6d4b2a1f3365b">ripple::KnownFormats::Item::getName</a></div><div class="ttdeci">std::string const &amp; getName() const</div><div class="ttdoc">Retrieve the name of the format.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00064">KnownFormats.h:64</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a534d1a44ed43326b856f8ffe357a33d3"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a534d1a44ed43326b856f8ffe357a33d3">ripple::KnownFormats::formats_</a></div><div class="ttdeci">std::forward_list&lt; Item &gt; formats_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00186">KnownFormats.h:186</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_a139c2cc44f47b650ccc6c4cf8665a247"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#a139c2cc44f47b650ccc6c4cf8665a247">ripple::KnownFormats::Item::type_</a></div><div class="ttdeci">const KeyType type_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00086">KnownFormats.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_acc7de39aaa3558f967a3ece1bda382a0"><div class="ttname"><a href="classripple_1_1KnownFormats.html#acc7de39aaa3558f967a3ece1bda382a0">ripple::KnownFormats::operator=</a></div><div class="ttdeci">KnownFormats &amp; operator=(KnownFormats const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_a504752f8ad1fa863036283aad1426914"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#a504752f8ad1fa863036283aad1426914">ripple::KnownFormats::Item::soTemplate_</a></div><div class="ttdeci">SOTemplate soTemplate_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00084">KnownFormats.h:84</a></div></div>
<div class="ttc" id="aalgorithm_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_a04d9fe5392d260b25fd5b1ac14fb6df5"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#a04d9fe5392d260b25fd5b1ac14fb6df5">ripple::KnownFormats::Item::name_</a></div><div class="ttdeci">const std::string name_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00085">KnownFormats.h:85</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html">ripple::KnownFormats::Item</a></div><div class="ttdoc">A known format.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00044">KnownFormats.h:44</a></div></div>
<div class="ttc" id="aforward_list_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/forward_list.html">forward_list</a></div></div>
<div class="ttc" id="ais_enum_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_enum.html">std::is_enum</a></div></div>
<div class="ttc" id="aclassripple_1_1SOTemplate_html"><div class="ttname"><a href="classripple_1_1SOTemplate.html">ripple::SOTemplate</a></div><div class="ttdoc">Defines the fields and their attributes within a STObject.</div><div class="ttdef"><b>Definition:</b> <a href="SOTemplate_8h_source.html#l00081">SOTemplate.h:81</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_af1d7ab9877aec91f1765922566d9b477"><div class="ttname"><a href="classripple_1_1KnownFormats.html#af1d7ab9877aec91f1765922566d9b477">ripple::KnownFormats::names_</a></div><div class="ttdeci">boost::container::flat_map&lt; std::string, Item const * &gt; names_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00188">KnownFormats.h:188</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html"><div class="ttname"><a href="classripple_1_1KnownFormats.html">ripple::KnownFormats</a></div><div class="ttdoc">Manages a list of known formats.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00039">KnownFormats.h:39</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_ab3a38712296e0e75e394baaa8a1b3211"><div class="ttname"><a href="classripple_1_1KnownFormats.html#ab3a38712296e0e75e394baaa8a1b3211">ripple::KnownFormats::findByType</a></div><div class="ttdeci">Item const * findByType(KeyType type) const</div><div class="ttdoc">Retrieve a format based on its type.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00125">KnownFormats.h:125</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_ab75ce40a274a032c312bae5bacb8e087"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#ab75ce40a274a032c312bae5bacb8e087">ripple::KnownFormats::Item::getSOTemplate</a></div><div class="ttdeci">SOTemplate const &amp; getSOTemplate() const</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00078">KnownFormats.h:78</a></div></div>
<div class="ttc" id="ais_integral_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral</a></div></div>
<div class="ttc" id="anamespaceripple_html_a9de744cfdefe1132969eb982e57e4dde"><div class="ttname"><a href="namespaceripple.html#a9de744cfdefe1132969eb982e57e4dde">ripple::KeyType</a></div><div class="ttdeci">KeyType</div><div class="ttdef"><b>Definition:</b> <a href="KeyType_8h_source.html#l00028">KeyType.h:28</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_1KnownFormats_html_a69662755c4d487308e7a4a79811349e3"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a69662755c4d487308e7a4a79811349e3">ripple::KnownFormats::~KnownFormats</a></div><div class="ttdeci">virtual ~KnownFormats()=default</div><div class="ttdoc">Destroy the known formats object.</div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a30bdc49492ab65e9fb73306d16e593f1"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a30bdc49492ab65e9fb73306d16e593f1">ripple::KnownFormats::findByName</a></div><div class="ttdeci">Item const * findByName(std::string const &amp;name) const</div><div class="ttdoc">Retrieve a format based on its name.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00150">KnownFormats.h:150</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_a4ea6608597737091d083001f02a1634a"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#a4ea6608597737091d083001f02a1634a">ripple::KnownFormats::Item::getType</a></div><div class="ttdeci">KeyType getType() const</div><div class="ttdoc">Retrieve the transaction type this format represents.</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00072">KnownFormats.h:72</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a61870a3c657db7800ccf911166294a48"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a61870a3c657db7800ccf911166294a48">ripple::KnownFormats::KnownFormats</a></div><div class="ttdeci">KnownFormats()=default</div><div class="ttdoc">Create the known formats object.</div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_aa292c93d9151dfcf55c963c30afa132d"><div class="ttname"><a href="classripple_1_1KnownFormats.html#aa292c93d9151dfcf55c963c30afa132d">ripple::KnownFormats::types_</a></div><div class="ttdeci">boost::container::flat_map&lt; KeyType, Item const * &gt; types_</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00189">KnownFormats.h:189</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a856eadbc12d29b208d258ff3a83109aa"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a856eadbc12d29b208d258ff3a83109aa">ripple::KnownFormats::end</a></div><div class="ttdeci">std::forward_list&lt; Item &gt;::const_iterator end() const</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00141">KnownFormats.h:141</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_html_a1df800bc2f63ea614243b6e7a996e5b1"><div class="ttname"><a href="classripple_1_1KnownFormats.html#a1df800bc2f63ea614243b6e7a996e5b1">ripple::KnownFormats::begin</a></div><div class="ttdeci">std::forward_list&lt; Item &gt;::const_iterator begin() const</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00135">KnownFormats.h:135</a></div></div>
<div class="ttc" id="aclassripple_1_1KnownFormats_1_1Item_html_abfb0c207121d265f657d487ee1853f95"><div class="ttname"><a href="classripple_1_1KnownFormats_1_1Item.html#abfb0c207121d265f657d487ee1853f95">ripple::KnownFormats::Item::Item</a></div><div class="ttdeci">Item(char const *name, KeyType type, std::initializer_list&lt; SOElement &gt; uniqueFields, std::initializer_list&lt; SOElement &gt; commonFields)</div><div class="ttdef"><b>Definition:</b> <a href="KnownFormats_8h_source.html#l00047">KnownFormats.h:47</a></div></div>
<div class="ttc" id="ainitializer_list_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/initializer_list.html">std::initializer_list</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>
Reference in New Issue View Git Blame Copy Permalink