#include <util.h>
|
enum class | Type {
OBJ
, ARR
, STR
, NUM
,
BOOL
, OBJ_USER_KEYS
, AMOUNT
, STR_HEX
,
RANGE
} |
|
enum class | Optional { NO
, OMITTED_NAMED_ARG
, OMITTED
} |
|
using | DefaultHint = std::string |
|
using | Default = UniValue |
|
using | Fallback = std::variant< Optional, DefaultHint, Default > |
|
|
| RPCArg (const std::string name, const Type type, const Fallback fallback, const std::string description, const std::string oneline_description="", const std::vector< std::string > type_str={}, const bool hidden=false) |
|
| RPCArg (const std::string name, const Type type, const Fallback fallback, const std::string description, const std::vector< RPCArg > inner, const std::string oneline_description="", const std::vector< std::string > type_str={}) |
|
bool | IsOptional () const |
|
std::string | GetFirstName () const |
| Return the first of all aliases. More...
|
|
std::string | GetName () const |
| Return the name, throws when there are aliases. More...
|
|
std::string | ToString (bool oneline) const |
| Return the type string of the argument. More...
|
|
std::string | ToStringObj (bool oneline) const |
| Return the type string of the argument when it is in an object (dict). More...
|
|
std::string | ToDescriptionString () const |
| Return the description string, including the argument type and whether the argument is required. More...
|
|
Definition at line 137 of file util.h.
◆ Default
◆ DefaultHint
◆ Fallback
◆ Optional
Enumerator |
---|
NO | Required arg.
|
OMITTED_NAMED_ARG | Optional arg that is a named argument and has a default value of null .
When possible, the default value should be specified.
|
OMITTED | Optional argument with default value omitted because they are implicitly clear.
That is, elements in an array or object may not exist by default. When possible, the default value should be specified.
|
Definition at line 157 of file util.h.
◆ Type
Enumerator |
---|
OBJ | |
ARR | |
STR | |
NUM | |
BOOL | |
OBJ_USER_KEYS | Special type where the user must set the keys e.g.
to define multiple addresses; as opposed to e.g. an options object where the keys are predefined
|
AMOUNT | Special type representing a floating point amount (can be either NUM or STR)
|
STR_HEX | Special type that is a STR with only hex chars.
|
RANGE | Special type that is a NUM or [NUM,NUM].
|
Definition at line 138 of file util.h.
◆ RPCArg() [1/2]
RPCArg::RPCArg |
( |
const std::string |
name, |
|
|
const Type |
type, |
|
|
const Fallback |
fallback, |
|
|
const std::string |
description, |
|
|
const std::string |
oneline_description = "" , |
|
|
const std::vector< std::string > |
type_str = {} , |
|
|
const bool |
hidden = false |
|
) |
| |
|
inline |
◆ RPCArg() [2/2]
RPCArg::RPCArg |
( |
const std::string |
name, |
|
|
const Type |
type, |
|
|
const Fallback |
fallback, |
|
|
const std::string |
description, |
|
|
const std::vector< RPCArg > |
inner, |
|
|
const std::string |
oneline_description = "" , |
|
|
const std::vector< std::string > |
type_str = {} |
|
) |
| |
|
inline |
◆ GetFirstName()
std::string RPCArg::GetFirstName |
( |
| ) |
const |
Return the first of all aliases.
Definition at line 712 of file util.cpp.
◆ GetName()
std::string RPCArg::GetName |
( |
| ) |
const |
Return the name, throws when there are aliases.
Definition at line 716 of file util.cpp.
◆ IsOptional()
bool RPCArg::IsOptional |
( |
| ) |
const |
◆ ToDescriptionString()
std::string RPCArg::ToDescriptionString |
( |
| ) |
const |
Return the description string, including the argument type and whether the argument is required.
Definition at line 729 of file util.cpp.
◆ ToString()
std::string RPCArg::ToString |
( |
bool |
oneline | ) |
const |
Return the type string of the argument.
Set oneline to allow it to be overridden by a custom oneline type string (m_oneline_description).
Definition at line 986 of file util.cpp.
◆ ToStringObj()
std::string RPCArg::ToStringObj |
( |
bool |
oneline | ) |
const |
Return the type string of the argument when it is in an object (dict).
Set oneline to get the oneline representation (less whitespace)
Definition at line 947 of file util.cpp.
◆ m_description
const std::string RPCArg::m_description |
◆ m_fallback
◆ m_hidden
const bool RPCArg::m_hidden |
◆ m_inner
const std::vector<RPCArg> RPCArg::m_inner |
Only used for arrays or dicts.
Definition at line 184 of file util.h.
◆ m_names
const std::string RPCArg::m_names |
The name of the arg (can be empty for inner args, can contain multiple aliases separated by | for named request arguments)
Definition at line 180 of file util.h.
◆ m_oneline_description
const std::string RPCArg::m_oneline_description |
Should be empty unless it is supposed to override the auto-generated summary line.
Definition at line 189 of file util.h.
◆ m_type
const Type RPCArg::m_type |
◆ m_type_str
const std::vector<std::string> RPCArg::m_type_str |
Should be empty unless it is supposed to override the auto-generated type strings.
Vector length is either 0 or 2, m_type_str.at(0) will override the type of the value in a key-value pair, m_type_str.at(1) will override the type in the argument description.
Definition at line 196 of file util.h.
The documentation for this struct was generated from the following files: