Describes one part of an RPC method's result for type checking and help text.
Synopsis
Declared in <rpc/util.h>
struct RPCResult;Enums
Name |
Description |
The JSON type of the result field. |
Member Functions
Name |
Description |
|
Constructors |
Check whether the result JSON type matches. Returns true if type matches, or object describing error(s) if not. |
|
Return the description string, including the result type. |
|
Append the sections of the result. |
|
Return the type string of the result when it is in an object (dict). |
Data Members
Name |
Description |
Condition under which the field is present (empty if unconditional). |
|
Human‐readable description of the field. |
|
Only used for arrays or dicts |
|
Only used for dicts |
|
Whether the field may be absent from the result. |
|
Additional options controlling validation and rendering. |
|
The JSON type of the result field. |
Non-Member Functions
Name |
Description |
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. |
|
Return the standard result documentation for a scriptPubKey object. |
|
Explain the UniValue "decoded" transaction object, may include extra fields if processed by wallet |
Created with MrDocs