Bitcoin Core  27.99.0
P2P Digital Currency
Public Attributes | List of all members
RPCArgOptions Struct Reference

#include <util.h>

Public Attributes

bool skip_type_check {false}
 
std::string oneline_description {}
 Should be empty unless it is supposed to override the auto-generated summary line. More...
 
std::vector< std::string > type_str {}
 Should be empty unless it is supposed to override the auto-generated type strings. Vector length is either 0 or 2, m_opts.type_str.at(0) will override the type of the value in a key-value pair, m_opts.type_str.at(1) will override the type in the argument description. More...
 
bool hidden {false}
 For testing only. More...
 
bool also_positional {false}
 If set allows a named-parameter field in an OBJ_NAMED_PARAM options object to have the same name as a top-level parameter. More...
 

Detailed Description

Definition at line 155 of file util.h.

Member Data Documentation

◆ also_positional

bool RPCArgOptions::also_positional {false}

If set allows a named-parameter field in an OBJ_NAMED_PARAM options object to have the same name as a top-level parameter.

By default the RPC framework disallows this, because if an RPC request passes the value by name, it is assigned to top-level parameter position, not to the options position, defeating the purpose of using OBJ_NAMED_PARAMS instead OBJ for that option. But sometimes it makes sense to allow less-commonly used options to be passed by name only, and more commonly used options to be passed by name or position, so the RPC framework allows this as long as methods set the also_positional flag and read values from both positions.

Definition at line 160 of file util.h.

◆ hidden

bool RPCArgOptions::hidden {false}

For testing only.

Definition at line 159 of file util.h.

◆ oneline_description

std::string RPCArgOptions::oneline_description {}

Should be empty unless it is supposed to override the auto-generated summary line.

Definition at line 157 of file util.h.

◆ skip_type_check

bool RPCArgOptions::skip_type_check {false}

Definition at line 156 of file util.h.

◆ type_str

std::vector<std::string> RPCArgOptions::type_str {}

Should be empty unless it is supposed to override the auto-generated type strings. Vector length is either 0 or 2, m_opts.type_str.at(0) will override the type of the value in a key-value pair, m_opts.type_str.at(1) will override the type in the argument description.

Definition at line 158 of file util.h.


The documentation for this struct was generated from the following file: