#include <util.h>

Public Types
enum	Type { Type::OBJ, Type::ARR, Type::STR, Type::NUM, Type::BOOL, Type::OBJ_USER_KEYS, Type::AMOUNT, Type::STR_HEX, Type::RANGE }

enum	Optional { Optional::NO, Optional::OMITTED_NAMED_ARG, Optional::OMITTED }

using	DefaultHint = std::string

using	Default = UniValue

using	Fallback = std::variant< Optional, DefaultHint, Default >

Public Member Functions
	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...

Public Attributes
const std::string	m_names
	The name of the arg (can be empty for inner args, can contain multiple aliases separated by \| for named request arguments) More...

const Type	m_type

const bool	m_hidden

const std::vector< RPCArg >	m_inner
	Only used for arrays or dicts. More...

const Fallback	m_fallback

const std::string	m_description

const std::string	m_oneline_description
	Should be empty unless it is supposed to override the auto-generated summary line. More...

const std::vector< std::string >	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. More...

Detailed Description

Definition at line 126 of file util.h.

Member Typedef Documentation

◆ Default

using RPCArg::Default = UniValue

Definition at line 156 of file util.h.

◆ DefaultHint

using RPCArg::DefaultHint = std::string

Definition at line 155 of file util.h.

◆ Fallback

using RPCArg::Fallback = std::variant<Optional, DefaultHint, Default>

Definition at line 157 of file util.h.

Member Enumeration Documentation

◆ Optional

enum RPCArg::Optional

strong

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 139 of file util.h.

◆ Type

enum RPCArg::Type

strong

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 127 of file util.h.

Constructor & Destructor Documentation

◆ 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

Definition at line 167 of file util.h.

◆ 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

Definition at line 186 of file util.h.

Member Function Documentation

◆ GetFirstName()

std::string RPCArg::GetFirstName ( ) const

Return the first of all aliases.

Definition at line 673 of file util.cpp.

Here is the caller graph for this function:

◆ GetName()

std::string RPCArg::GetName ( ) const

Return the name, throws when there are aliases.

Definition at line 678 of file util.cpp.

Here is the caller graph for this function:

◆ IsOptional()

bool RPCArg::IsOptional ( ) const

Definition at line 684 of file util.cpp.

◆ ToDescriptionString()

std::string RPCArg::ToDescriptionString ( ) const

Return the description string, including the argument type and whether the argument is required.

Definition at line 693 of file util.cpp.

Here is the caller graph for this function:

◆ 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 940 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 903 of file util.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_description

const std::string RPCArg::m_description

Definition at line 163 of file util.h.

◆ m_fallback

const Fallback RPCArg::m_fallback

Definition at line 162 of file util.h.

◆ m_hidden

const bool RPCArg::m_hidden

Definition at line 160 of file util.h.

◆ m_inner

const std::vector<RPCArg> RPCArg::m_inner

Only used for arrays or dicts.

Definition at line 161 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 158 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 164 of file util.h.

◆ m_type

const Type RPCArg::m_type

Definition at line 159 of file util.h.

◆ 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 165 of file util.h.

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

src/rpc/util.h
src/rpc/util.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ Default

◆ DefaultHint

◆ Fallback

Member Enumeration Documentation

◆ Optional

◆ Type

Constructor & Destructor Documentation

◆ RPCArg() [1/2]

◆ RPCArg() [2/2]

Member Function Documentation

◆ GetFirstName()

◆ GetName()

◆ IsOptional()

◆ ToDescriptionString()

◆ ToString()

◆ ToStringObj()

Member Data Documentation

◆ m_description

◆ m_fallback

◆ m_hidden

◆ m_inner

◆ m_names

◆ m_oneline_description

◆ m_type

◆ m_type_str