RPCResult Struct Reference

#include <util.h>

Public Types
enum class	Type {   OBJ , ARR , STR , NUM ,   BOOL , NONE , ANY , STR_AMOUNT ,   STR_HEX , OBJ_DYN , ARR_FIXED , NUM_TIME ,   ELISION }

Public Member Functions
	RPCResult (std::string cond, Type type, std::string key_name, bool optional, std::string description, std::vector< RPCResult > inner={})
	RPCResult (std::string cond, Type type, std::string key_name, std::string description, std::vector< RPCResult > inner={})
	RPCResult (Type type, std::string key_name, bool optional, std::string description, std::vector< RPCResult > inner={}, bool skip_type_check=false)
	RPCResult (Type type, std::string key_name, std::string description, std::vector< RPCResult > inner={}, bool skip_type_check=false)
void	ToSections (Sections &sections, OuterType outer_type=OuterType::NONE, const int current_indent=0) const
	Append the sections of the result.
std::string	ToStringObj () const
	Return the type string of the result when it is in an object (dict).
std::string	ToDescriptionString () const
	Return the description string, including the result type.
UniValue	MatchesType (const UniValue &result) const
	Check whether the result JSON type matches.

Public Attributes
const Type	m_type
const std::string	m_key_name
	Only used for dicts.
const std::vector< RPCResult >	m_inner
	Only used for arrays or dicts.
const bool	m_optional
const bool	m_skip_type_check
const std::string	m_description
const std::string	m_cond

Private Member Functions
void	CheckInnerDoc () const

Detailed Description

Definition at line 263 of file util.h.

Member Enumeration Documentation

Type

enum class RPCResult::Type

strong

Enumerator
OBJ
ARR
STR
NUM
BOOL
NONE
ANY	Special type to disable type checks (for testing only)
STR_AMOUNT	Special string to represent a floating point amount.
STR_HEX	Special string with only hex chars.
OBJ_DYN	Special dictionary with keys that are not literals.
ARR_FIXED	Special array that has a fixed number of entries.
NUM_TIME	Special numeric to denote unix epoch time.
ELISION	Special type to denote elision (...)

Definition at line 264 of file util.h.

Constructor & Destructor Documentation

RPCResult() [1/4]

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

inline

Definition at line 288 of file util.h.

RPCResult() [2/4]

RPCResult::RPCResult ( std::string  cond, Type  type, std::string  key_name, std::string  description, std::vector< RPCResult >  inner = {}  )

inline

Definition at line 298 of file util.h.

RPCResult() [3/4]

RPCResult::RPCResult ( Type  type, std::string  key_name, bool  optional, std::string  description, std::vector< RPCResult >  inner = {}, bool  skip_type_check = false  )

inline

Definition at line 304 of file util.h.

RPCResult() [4/4]

RPCResult::RPCResult ( Type  type, std::string  key_name, std::string  description, std::vector< RPCResult >  inner = {}, bool  skip_type_check = false  )

inline

Definition at line 314 of file util.h.

Member Function Documentation

CheckInnerDoc()

void RPCResult::CheckInnerDoc ( ) const

private

Definition at line 1164 of file util.cpp.

Here is the call graph for this function:

MatchesType()

UniValue RPCResult::MatchesType

(

const UniValue &

result

)

const

Check whether the result JSON type matches.

Returns true if type matches, or object describing error(s) if not.

Definition at line 1072 of file util.cpp.

Here is the call graph for this function:

ToDescriptionString()

std::string RPCResult::ToDescriptionString

(

)

const

Return the description string, including the result type.

ToSections()

void RPCResult::ToSections	(	Sections &	sections,
		OuterType	outer_type = OuterType::NONE,
		const int	current_indent = 0
	)		const

Append the sections of the result.

Definition at line 924 of file util.cpp.

Here is the call graph for this function:

ToStringObj()

std::string RPCResult::ToStringObj

(

)

const

Return the type string of the result when it is in an object (dict).

Member Data Documentation

m_cond

const std::string RPCResult::m_cond

Definition at line 286 of file util.h.

m_description

const std::string RPCResult::m_description

Definition at line 285 of file util.h.

m_inner

const std::vector<RPCResult> RPCResult::m_inner

Only used for arrays or dicts.

Definition at line 282 of file util.h.

m_key_name

const std::string RPCResult::m_key_name

Only used for dicts.

Definition at line 281 of file util.h.

m_optional

const bool RPCResult::m_optional

Definition at line 283 of file util.h.

m_skip_type_check

const bool RPCResult::m_skip_type_check

Definition at line 284 of file util.h.

m_type

const Type RPCResult::m_type

Definition at line 280 of file util.h.

---

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

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