Constructors

Synopses

Declared in <rpc/util.h>

Copy with replacement options, for stamping new opts onto an existing result.

RPCResult(
    RPCResult const& other,
    RPCResultOptions opts);

Construct an unconditional, non‐optional result field.

RPCResult(
    Type type,
    std::string m_key_name,
    std::string description,
    std::vector<RPCResult> inner = {},
    RPCResultOptions opts = {});

Construct an unconditional result field.

RPCResult(
    Type type,
    std::string m_key_name,
    bool optional,
    std::string description,
    std::vector<RPCResult> inner = {},
    RPCResultOptions opts = {});

Construct a conditional, non‐optional result field.

RPCResult(
    std::string cond,
    Type type,
    std::string m_key_name,
    std::string description,
    std::vector<RPCResult> inner = {},
    RPCResultOptions opts = {});

Construct a conditional result field.

RPCResult(
    std::string cond,
    Type type,
    std::string m_key_name,
    bool optional,
    std::string description,
    std::vector<RPCResult> inner = {},
    RPCResultOptions opts = {});

Parameters

Name

Description

other

The result to copy.

opts

The options to apply to the copy.

type

The JSON type of the field.

m_key_name

The field's key name (for object members).

description

Human‐readable description of the field.

inner

The nested fields for arrays or objects.

optional

Whether the field may be absent.

cond

Condition under which the field is present.

Created with MrDocs