ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-02-16 20:02:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9ef07fc10ff9ab5d7eebb9ef057e335fa5786a7
rippled/classxrpl_1_1STParsedJSONObject.html
bthomee a661b19a31 deploy: 1eb0fdac65
2025-12-11 08:55:10 -08:00

325 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: xrpl::STParsedJSONObject 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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexrpl.html">xrpl</a></li><li class="navelem"><a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classxrpl_1_1STParsedJSONObject-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">xrpl::STParsedJSONObject Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Holds the serialized result of parsing an input JSON object.
<a href="classxrpl_1_1STParsedJSONObject.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="STParsedJSON_8h_source.html">STParsedJSON.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for xrpl::STParsedJSONObject:</div>
<div class="dyncontent">
<div class="center"><img src="classxrpl_1_1STParsedJSONObject__coll__graph.png" border="0" usemap="#axrpl_1_1STParsedJSONObject_coll__map" alt="Collaboration graph"/></div>
<map name="axrpl_1_1STParsedJSONObject_coll__map" id="axrpl_1_1STParsedJSONObject_coll__map">
<area shape="rect" title="Holds the serialized result of parsing an input JSON object." alt="" coords="20,372,208,397"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="5,269,148,309"/>
<area shape="poly" title=" " alt="" coords="92,321,112,371,107,373,87,323"/>
<area shape="rect" href="classJson_1_1Value.html" title="Represents a JSON value." alt="" coords="173,277,266,302"/>
<area shape="poly" title=" " alt="" coords="198,313,129,374,125,370,195,309"/>
<area shape="poly" title=" " alt="" coords="281,279,289,283,293,290,284,299,267,301,266,296,282,294,287,289,285,287,279,284"/>
<area shape="rect" href="unionJson_1_1Value_1_1ValueHolder.html" title=" " alt="" coords="129,181,309,207"/>
<area shape="poly" title=" " alt="" coords="222,220,222,277,217,277,217,220"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="152,93,287,119"/>
<area shape="poly" title=" " alt="" coords="222,133,222,181,217,181,217,133"/>
<area shape="rect" title=" " alt="" coords="168,5,207,31"/>
<area shape="poly" title=" " alt="" coords="187,44,191,68,208,91,203,95,186,70,182,45"/>
<area shape="rect" title=" " alt="" coords="233,5,272,31"/>
<area shape="poly" title=" " alt="" coords="246,45,226,94,221,92,241,43"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae5e35d72e34a192dbc908f2fbc25c352" id="r_ae5e35d72e34a192dbc908f2fbc25c352"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#ae5e35d72e34a192dbc908f2fbc25c352">STParsedJSONObject</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name, <a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;json)</td></tr>
<tr class="memdesc:ae5e35d72e34a192dbc908f2fbc25c352"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses and creates an STParsedJSON object. <br /></td></tr>
<tr class="separator:ae5e35d72e34a192dbc908f2fbc25c352"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad030368fdd1a856dffed5627f252d2ad" id="r_ad030368fdd1a856dffed5627f252d2ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#ad030368fdd1a856dffed5627f252d2ad">STParsedJSONObject</a> ()=delete</td></tr>
<tr class="separator:ad030368fdd1a856dffed5627f252d2ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f252d362fe4316c2da57dd3c25b005f" id="r_a8f252d362fe4316c2da57dd3c25b005f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#a8f252d362fe4316c2da57dd3c25b005f">STParsedJSONObject</a> (<a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> const &amp;)=delete</td></tr>
<tr class="separator:a8f252d362fe4316c2da57dd3c25b005f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae261313aa4d2686f10cdddbc02ca29c2" id="r_ae261313aa4d2686f10cdddbc02ca29c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#ae261313aa4d2686f10cdddbc02ca29c2">operator=</a> (<a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> const &amp;)=delete</td></tr>
<tr class="separator:ae261313aa4d2686f10cdddbc02ca29c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4183d64a0760a40839039a9d68d0616" id="r_af4183d64a0760a40839039a9d68d0616"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#af4183d64a0760a40839039a9d68d0616">~STParsedJSONObject</a> ()=default</td></tr>
<tr class="separator:af4183d64a0760a40839039a9d68d0616"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6a5b736a4f1df57c7e1419ae6f606bf7" id="r_a6a5b736a4f1df57c7e1419ae6f606bf7"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classxrpl_1_1STObject.html">STObject</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#a6a5b736a4f1df57c7e1419ae6f606bf7">object</a></td></tr>
<tr class="memdesc:a6a5b736a4f1df57c7e1419ae6f606bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classxrpl_1_1STObject.html">STObject</a> if the parse was successful. <br /></td></tr>
<tr class="separator:a6a5b736a4f1df57c7e1419ae6f606bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc443eb612fd7e6a1c7e6ddf85ffda2" id="r_a7dc443eb612fd7e6a1c7e6ddf85ffda2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxrpl_1_1STParsedJSONObject.html#a7dc443eb612fd7e6a1c7e6ddf85ffda2">error</a></td></tr>
<tr class="memdesc:a7dc443eb612fd7e6a1c7e6ddf85ffda2"><td class="mdescLeft">&#160;</td><td class="mdescRight">On failure, an appropriate set of error values. <br /></td></tr>
<tr class="separator:a7dc443eb612fd7e6a1c7e6ddf85ffda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds the serialized result of parsing an input JSON object. </p>
<p>This does validation and checking on the provided JSON. </p>
<p class="definition">Definition at line <a class="el" href="STParsedJSON_8h_source.html#l00013">13</a> of file <a class="el" href="STParsedJSON_8h_source.html">STParsedJSON.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae5e35d72e34a192dbc908f2fbc25c352" name="ae5e35d72e34a192dbc908f2fbc25c352"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5e35d72e34a192dbc908f2fbc25c352">&#9670;&#160;</a></span>STParsedJSONObject() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xrpl::STParsedJSONObject::STParsedJSONObject </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classJson_1_1Value.html">Json::Value</a> const &amp;&#160;</td>
<td class="paramname"><em>json</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses and creates an STParsedJSON object. </p>
<p>The result of the parsing is stored in object and error. Exceptions: Does not throw. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the JSON field, used in diagnostics. </td></tr>
<tr><td class="paramname">json</td><td>The JSON-RPC to parse. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="STParsedJSON_8cpp_source.html#l01185">1185</a> of file <a class="el" href="STParsedJSON_8cpp_source.html">STParsedJSON.cpp</a>.</p>
</div>
</div>
<a id="ad030368fdd1a856dffed5627f252d2ad" name="ad030368fdd1a856dffed5627f252d2ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad030368fdd1a856dffed5627f252d2ad">&#9670;&#160;</a></span>STParsedJSONObject() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xrpl::STParsedJSONObject::STParsedJSONObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a8f252d362fe4316c2da57dd3c25b005f" name="a8f252d362fe4316c2da57dd3c25b005f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f252d362fe4316c2da57dd3c25b005f">&#9670;&#160;</a></span>STParsedJSONObject() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xrpl::STParsedJSONObject::STParsedJSONObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af4183d64a0760a40839039a9d68d0616" name="af4183d64a0760a40839039a9d68d0616"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4183d64a0760a40839039a9d68d0616">&#9670;&#160;</a></span>~STParsedJSONObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xrpl::STParsedJSONObject::~STParsedJSONObject </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="ae261313aa4d2686f10cdddbc02ca29c2" name="ae261313aa4d2686f10cdddbc02ca29c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae261313aa4d2686f10cdddbc02ca29c2">&#9670;&#160;</a></span>operator=()</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="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> &amp; xrpl::STParsedJSONObject::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxrpl_1_1STParsedJSONObject.html">STParsedJSONObject</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6a5b736a4f1df57c7e1419ae6f606bf7" name="a6a5b736a4f1df57c7e1419ae6f606bf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a5b736a4f1df57c7e1419ae6f606bf7">&#9670;&#160;</a></span>object</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>&lt;<a class="el" href="classxrpl_1_1STObject.html">STObject</a>&gt; xrpl::STParsedJSONObject::object</td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="classxrpl_1_1STObject.html">STObject</a> if the parse was successful. </p>
<p class="definition">Definition at line <a class="el" href="STParsedJSON_8h_source.html#l00032">32</a> of file <a class="el" href="STParsedJSON_8h_source.html">STParsedJSON.h</a>.</p>
</div>
</div>
<a id="a7dc443eb612fd7e6a1c7e6ddf85ffda2" name="a7dc443eb612fd7e6a1c7e6ddf85ffda2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc443eb612fd7e6a1c7e6ddf85ffda2">&#9670;&#160;</a></span>error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1Value.html">Json::Value</a> xrpl::STParsedJSONObject::error</td>
</tr>
</table>
</div><div class="memdoc">
<p>On failure, an appropriate set of error values. </p>
<p class="definition">Definition at line <a class="el" href="STParsedJSON_8h_source.html#l00035">35</a> of file <a class="el" href="STParsedJSON_8h_source.html">STParsedJSON.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink