Describes one part of an RPC method's result for type checking and help text.
Declared in <rpc/util.h>
struct RPCResult;| Name | Description |
|---|---|
Type | The JSON type of the result field. |
| Name | Description |
|---|---|
RPCResult [constructor] | Constructors |
MatchesType | Check whether the result JSON type matches. Returns true if type matches, or object describing error(s) if not. |
ToDescriptionString | Return the description string, including the result type. |
ToSections | Append the sections of the result. |
ToStringObj | Return the type string of the result when it is in an object (dict). |
| Name | Description |
|---|---|
m_cond | Condition under which the field is present (empty if unconditional). |
m_description | Human-readable description of the field. |
m_inner | Only used for arrays or dicts |
m_key_name | Only used for dicts |
m_optional | Whether the field may be absent from the result. |
m_opts | Additional options controlling validation and rendering. |
m_type | The JSON type of the result field. |
| Name | Description |
|---|---|
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. |
ScriptPubKeyDoc | Return the standard result documentation for a scriptPubKey object. |
TxDoc | Explain the UniValue "decoded" transaction object, may include extra fields if processed by wallet |