[#RPCResult]
= RPCResult
:mrdocs:

Describes one part of an RPC method's result for type checking and help text.

== Synopsis

Declared in `<rpc/util.h>`

[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.
|===


== 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. Returns true if type matches, or object describing error(s) if not.
| xref:RPCResult/ToDescriptionString.adoc[`ToDescriptionString`] 
| Return the description string, including the result type.
| xref:RPCResult/ToSections.adoc[`ToSections`] 
| Append the sections of the result.
| xref:RPCResult/ToStringObj.adoc[`ToStringObj`] 
| Return the type string of the result when it is in an object (dict).
|===


== Data Members

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


== Non-Member Functions

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


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