ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 20:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c97a868762c49dc3e04c25c2dd01f02be3e05e7c
rippled/classripple_1_1STParsedJSONArray.html
manojsdoshi c5ab09fd50 deploy: c66be3e6cf
2022-04-06 23:38:52 +00:00

311 lines
16 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: ripple::STParsedJSONArray 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 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</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="classripple_1_1STParsedJSONArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::STParsedJSONArray Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds the serialized result of parsing an input JSON array.
<a href="classripple_1_1STParsedJSONArray.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::STParsedJSONArray:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1STParsedJSONArray__coll__graph.png" border="0" usemap="#ripple_1_1STParsedJSONArray_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1STParsedJSONArray_coll__map" id="ripple_1_1STParsedJSONArray_coll__map">
<area shape="rect" title="Holds the serialized result of parsing an input JSON array." alt="" coords="149,377,343,404"/>
<area shape="rect" href="classJson_1_1Value.html" title="Represents a JSON value." alt="" coords="49,281,142,307"/>
<area shape="rect" href="unionJson_1_1Value_1_1ValueHolder.html" title=" " alt="" coords="5,184,185,211"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title="STL class." alt="" coords="28,95,163,121"/>
<area shape="rect" title=" " alt="" coords="43,5,81,32"/>
<area shape="rect" title=" " alt="" coords="109,5,148,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="219,273,374,315"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af70e133b97807762bc1462fce2e54634"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#af70e133b97807762bc1462fce2e54634">STParsedJSONArray</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:af70e133b97807762bc1462fce2e54634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses and creates an STParsedJSON array. <a href="classripple_1_1STParsedJSONArray.html#af70e133b97807762bc1462fce2e54634">More...</a><br /></td></tr>
<tr class="separator:af70e133b97807762bc1462fce2e54634"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff64a5a6805ea010242118eecaab8436"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#aff64a5a6805ea010242118eecaab8436">STParsedJSONArray</a> ()=delete</td></tr>
<tr class="separator:aff64a5a6805ea010242118eecaab8436"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc6604cd6afa4ee13dc7aa04d69a0640"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#afc6604cd6afa4ee13dc7aa04d69a0640">STParsedJSONArray</a> (<a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</a> const &amp;)=delete</td></tr>
<tr class="separator:afc6604cd6afa4ee13dc7aa04d69a0640"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb55b2fc969d7f7aaa83ebeef821cc53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#afb55b2fc969d7f7aaa83ebeef821cc53">operator=</a> (<a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</a> const &amp;)=delete</td></tr>
<tr class="separator:afb55b2fc969d7f7aaa83ebeef821cc53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad60bfc250d6a97b12fadb4402e21a7cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#ad60bfc250d6a97b12fadb4402e21a7cd">~STParsedJSONArray</a> ()=default</td></tr>
<tr class="separator:ad60bfc250d6a97b12fadb4402e21a7cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a15bd4b112bb54d2906b610523f800eab"><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="classripple_1_1STArray.html">STArray</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1STParsedJSONArray.html#a15bd4b112bb54d2906b610523f800eab">array</a></td></tr>
<tr class="memdesc:a15bd4b112bb54d2906b610523f800eab"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classripple_1_1STArray.html">STArray</a> if the parse was successful. <a href="classripple_1_1STParsedJSONArray.html#a15bd4b112bb54d2906b610523f800eab">More...</a><br /></td></tr>
<tr class="separator:a15bd4b112bb54d2906b610523f800eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23b8770e3b98ec8b116b56eb33e62aa7"><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="classripple_1_1STParsedJSONArray.html#a23b8770e3b98ec8b116b56eb33e62aa7">error</a></td></tr>
<tr class="memdesc:a23b8770e3b98ec8b116b56eb33e62aa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">On failure, an appropriate set of error values. <a href="classripple_1_1STParsedJSONArray.html#a23b8770e3b98ec8b116b56eb33e62aa7">More...</a><br /></td></tr>
<tr class="separator:a23b8770e3b98ec8b116b56eb33e62aa7"><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 array. </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#l00059">59</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="af70e133b97807762bc1462fce2e54634"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af70e133b97807762bc1462fce2e54634">&#9670;&nbsp;</a></span>STParsedJSONArray() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::STParsedJSONArray::STParsedJSONArray </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 array. </p>
<p>The result of the parsing is stored in array 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#l00972">972</a> of file <a class="el" href="STParsedJSON_8cpp_source.html">STParsedJSON.cpp</a>.</p>
</div>
</div>
<a id="aff64a5a6805ea010242118eecaab8436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff64a5a6805ea010242118eecaab8436">&#9670;&nbsp;</a></span>STParsedJSONArray() <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">ripple::STParsedJSONArray::STParsedJSONArray </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="afc6604cd6afa4ee13dc7aa04d69a0640"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc6604cd6afa4ee13dc7aa04d69a0640">&#9670;&nbsp;</a></span>STParsedJSONArray() <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">ripple::STParsedJSONArray::STParsedJSONArray </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</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="ad60bfc250d6a97b12fadb4402e21a7cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad60bfc250d6a97b12fadb4402e21a7cd">&#9670;&nbsp;</a></span>~STParsedJSONArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::STParsedJSONArray::~STParsedJSONArray </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="afb55b2fc969d7f7aaa83ebeef821cc53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb55b2fc969d7f7aaa83ebeef821cc53">&#9670;&nbsp;</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="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</a>&amp; ripple::STParsedJSONArray::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1STParsedJSONArray.html">STParsedJSONArray</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="a15bd4b112bb54d2906b610523f800eab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15bd4b112bb54d2906b610523f800eab">&#9670;&nbsp;</a></span>array</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="classripple_1_1STArray.html">STArray</a>&gt; ripple::STParsedJSONArray::array</td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="classripple_1_1STArray.html">STArray</a> if the parse was successful. </p>
<p class="definition">Definition at line <a class="el" href="STParsedJSON_8h_source.html#l00078">78</a> of file <a class="el" href="STParsedJSON_8h_source.html">STParsedJSON.h</a>.</p>
</div>
</div>
<a id="a23b8770e3b98ec8b116b56eb33e62aa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23b8770e3b98ec8b116b56eb33e62aa7">&#9670;&nbsp;</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> ripple::STParsedJSONArray::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#l00081">81</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="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