update api docs

This commit is contained in:
woodser
2024-01-27 14:33:18 -05:00
parent d1f74b0e49
commit 0fd9c30a3d
248 changed files with 7684 additions and 7988 deletions
+37 -19
View File
@@ -1,14 +1,16 @@
<!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">
<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.4"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Monero C++ Library: utils/monero_utils.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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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>
@@ -29,10 +31,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -41,11 +43,16 @@ var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -55,9 +62,16 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<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">
@@ -80,6 +94,7 @@ $(function() {
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#include &quot;serialization/keyvalue_serialization.h&quot;</span> <span class="comment">// TODO: consolidate with other binary deps?</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#include &quot;storages/portable_storage.h&quot;</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="namespacemonero__utils.html"> 66</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacemonero__utils.html">monero_utils</a></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>{</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">using namespace </span>cryptonote;</div>
@@ -108,11 +123,13 @@ $(function() {
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> std::string serialize(<span class="keyword">const</span> rapidjson::Document&amp; doc);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="foldopen" id="foldopen00099" data-start="{" data-end="}">
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774"> 99</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, T val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field) {</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> rapidjson::Value field_key(key.c_str(), key.size(), allocator);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> field.SetInt64((uint64_t) val);</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> root.AddMember(field_key, field, allocator);</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> }</div>
</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, std::string val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root, rapidjson::Value&amp; field);</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">add_json_member</a>(std::string key, <span class="keywordtype">bool</span> val, rapidjson::Document::AllocatorType&amp; allocator, rapidjson::Value&amp; root);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
@@ -251,7 +268,7 @@ $(function() {
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> }</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> </div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> <span class="keyword">static</span> <span class="keywordtype">void</span> free(std::vector&lt;std::shared_ptr&lt;monero_block&gt;&gt; blocks) {</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_block&gt;&amp; block : blocks) monero_utils::free(block);</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> <span class="keywordflow">for</span> (std::shared_ptr&lt;monero_block&gt;&amp; block : blocks) <a class="code hl_namespace" href="namespacemonero__utils.html">monero_utils</a>::free(block);</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> }</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> </div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> <span class="keyword">static</span> <span class="keywordtype">void</span> free(std::shared_ptr&lt;monero_tx&gt; tx) {</div>
@@ -275,20 +292,21 @@ $(function() {
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> <span class="keywordflow">return</span> monero_utils::free(monero_utils::get_blocks_from_outputs(outputs));</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> }</div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span>}</div>
</div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span><span class="preprocessor">#endif </span><span class="comment">/* monero_utils_h */</span><span class="preprocessor"></span></div>
<div class="ttc" id="anamespacemonero__utils_html"><div class="ttname"><a href="namespacemonero__utils.html">monero_utils</a></div><div class="ttdef"><b>Definition:</b> monero_utils.h:67</div></div>
<div class="ttc" id="anamespacemonero__utils_html_a3b9ee3d8bd81e28c3bbdf4e747300277"><div class="ttname"><a href="namespacemonero__utils.html#a3b9ee3d8bd81e28c3bbdf4e747300277">monero_utils::is_valid_language</a></div><div class="ttdeci">bool is_valid_language(const std::string &amp;language)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:303</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ab2fb8889ec17d02e54541e90a3ffd47f"><div class="ttname"><a href="namespacemonero__utils.html#ab2fb8889ec17d02e54541e90a3ffd47f">monero_utils::cn_block_to_block</a></div><div class="ttdeci">std::shared_ptr&lt; monero_block &gt; cn_block_to_block(const cryptonote::block &amp;cn_block)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:316</div></div>
<div class="ttc" id="anamespacemonero__utils_html_abc8108fdc0269db2f50c2ac24d7e5774"><div class="ttname"><a href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">monero_utils::add_json_member</a></div><div class="ttdeci">void add_json_member(std::string key, T val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</div><div class="ttdef"><b>Definition:</b> monero_utils.h:99</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ad4b5df3026350e762bfa40c6acdb6a0d"><div class="ttname"><a href="namespacemonero__utils.html#ad4b5df3026350e762bfa40c6acdb6a0d">monero_utils::cn_tx_to_tx</a></div><div class="ttdeci">std::shared_ptr&lt; monero_tx &gt; cn_tx_to_tx(const cryptonote::transaction &amp;cn_tx, bool init_as_tx_wallet=false)</div><div class="ttdef"><b>Definition:</b> monero_utils.cpp:332</div></div>
<div class="ttc" id="anamespacemonero_html_ac9023a1d513e2526775d1e061bb5beed"><div class="ttname"><a href="namespacemonero.html#ac9023a1d513e2526775d1e061bb5beed">monero::monero_network_type</a></div><div class="ttdeci">monero_network_type</div><div class="ttdef"><b>Definition:</b> monero_daemon_model.h:90</div></div>
<div class="ttc" id="astructmonero_1_1monero__integrated__address_html"><div class="ttname"><a href="structmonero_1_1monero__integrated__address.html">monero::monero_integrated_address</a></div><div class="ttdef"><b>Definition:</b> monero_wallet_model.h:350</div></div>
<div class="ttc" id="astructmonero_1_1monero__tx__query_html"><div class="ttname"><a href="structmonero_1_1monero__tx__query.html">monero::monero_tx_query</a></div><div class="ttdef"><b>Definition:</b> monero_wallet_model.h:305</div></div>
<div class="ttc" id="astructmonero_1_1monero__tx__wallet_html"><div class="ttname"><a href="structmonero_1_1monero__tx__wallet.html">monero::monero_tx_wallet</a></div><div class="ttdef"><b>Definition:</b> monero_wallet_model.h:271</div></div>
<div class="ttc" id="anamespacemonero__utils_html"><div class="ttname"><a href="namespacemonero__utils.html">monero_utils</a></div><div class="ttdef"><b>Definition</b> monero_utils.h:67</div></div>
<div class="ttc" id="anamespacemonero__utils_html_a3b9ee3d8bd81e28c3bbdf4e747300277"><div class="ttname"><a href="namespacemonero__utils.html#a3b9ee3d8bd81e28c3bbdf4e747300277">monero_utils::is_valid_language</a></div><div class="ttdeci">bool is_valid_language(const std::string &amp;language)</div><div class="ttdef"><b>Definition</b> monero_utils.cpp:303</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ab2fb8889ec17d02e54541e90a3ffd47f"><div class="ttname"><a href="namespacemonero__utils.html#ab2fb8889ec17d02e54541e90a3ffd47f">monero_utils::cn_block_to_block</a></div><div class="ttdeci">std::shared_ptr&lt; monero_block &gt; cn_block_to_block(const cryptonote::block &amp;cn_block)</div><div class="ttdef"><b>Definition</b> monero_utils.cpp:316</div></div>
<div class="ttc" id="anamespacemonero__utils_html_abc8108fdc0269db2f50c2ac24d7e5774"><div class="ttname"><a href="namespacemonero__utils.html#abc8108fdc0269db2f50c2ac24d7e5774">monero_utils::add_json_member</a></div><div class="ttdeci">void add_json_member(std::string key, T val, rapidjson::Document::AllocatorType &amp;allocator, rapidjson::Value &amp;root, rapidjson::Value &amp;field)</div><div class="ttdef"><b>Definition</b> monero_utils.h:99</div></div>
<div class="ttc" id="anamespacemonero__utils_html_ad4b5df3026350e762bfa40c6acdb6a0d"><div class="ttname"><a href="namespacemonero__utils.html#ad4b5df3026350e762bfa40c6acdb6a0d">monero_utils::cn_tx_to_tx</a></div><div class="ttdeci">std::shared_ptr&lt; monero_tx &gt; cn_tx_to_tx(const cryptonote::transaction &amp;cn_tx, bool init_as_tx_wallet=false)</div><div class="ttdef"><b>Definition</b> monero_utils.cpp:332</div></div>
<div class="ttc" id="anamespacemonero_html_ac9023a1d513e2526775d1e061bb5beed"><div class="ttname"><a href="namespacemonero.html#ac9023a1d513e2526775d1e061bb5beed">monero::monero_network_type</a></div><div class="ttdeci">monero_network_type</div><div class="ttdef"><b>Definition</b> monero_daemon_model.h:90</div></div>
<div class="ttc" id="astructmonero_1_1monero__integrated__address_html"><div class="ttname"><a href="structmonero_1_1monero__integrated__address.html">monero::monero_integrated_address</a></div><div class="ttdef"><b>Definition</b> monero_wallet_model.h:350</div></div>
<div class="ttc" id="astructmonero_1_1monero__tx__query_html"><div class="ttname"><a href="structmonero_1_1monero__tx__query.html">monero::monero_tx_query</a></div><div class="ttdef"><b>Definition</b> monero_wallet_model.h:305</div></div>
<div class="ttc" id="astructmonero_1_1monero__tx__wallet_html"><div class="ttname"><a href="structmonero_1_1monero__tx__wallet.html">monero::monero_tx_wallet</a></div><div class="ttdef"><b>Definition</b> monero_wallet_model.h:271</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>