[#RPCResult]
= RPCResult
:mrdocs:

Describes one part of an RPC method&apos;s result for type checking and help text&period;

== Synopsis

Declared in `&lt;rpc&sol;util&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct RPCResult;
----

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:RPCResult/Type.adoc[`Type`] 
| The JSON type of the result field&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:RPCResult/2constructor-0f.adoc[`RPCResult`]         [.small]#[constructor]#
| Constructors
| xref:RPCResult/MatchesType.adoc[`MatchesType`] 
| Check whether the result JSON type matches&period; Returns true if type matches, or object describing error(s) if not&period;
| xref:RPCResult/ToDescriptionString.adoc[`ToDescriptionString`] 
| Return the description string, including the result type&period;
| xref:RPCResult/ToSections.adoc[`ToSections`] 
| Append the sections of the result&period;
| xref:RPCResult/ToStringObj.adoc[`ToStringObj`] 
| Return the type string of the result when it is in an object (dict)&period;
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:RPCResult/m_cond.adoc[`m&lowbar;cond`] 
| Condition under which the field is present (empty if unconditional)&period;
| xref:RPCResult/m_description.adoc[`m&lowbar;description`] 
| Human&hyphen;readable description of the field&period;
| xref:RPCResult/m_inner.adoc[`m&lowbar;inner`] 
| Only used for arrays or dicts
| xref:RPCResult/m_key_name.adoc[`m&lowbar;key&lowbar;name`] 
| Only used for dicts
| xref:RPCResult/m_optional.adoc[`m&lowbar;optional`] 
| Whether the field may be absent from the result&period;
| xref:RPCResult/m_opts.adoc[`m&lowbar;opts`] 
| Additional options controlling validation and rendering&period;
| xref:RPCResult/m_type.adoc[`m&lowbar;type`] 
| The JSON type of the result field&period;
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:ElideGroup.adoc[`ElideGroup`]
| Stamp elision onto an entire vector of RPCResult fields at once&period; Merges into existing m&lowbar;opts so that flags like skip&lowbar;type&lowbar;check are preserved&period;
| xref:ScriptPubKeyDoc.adoc[`ScriptPubKeyDoc`]
| Return the standard result documentation for a scriptPubKey object&period;
| xref:TxDoc.adoc[`TxDoc`]
| Explain the UniValue &quot;decoded&quot; transaction object, may include extra fields if processed by wallet
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
