Bitcoin Core  0.18.99
P2P Digital Currency
Public Member Functions | Private Attributes | List of all members
RPCHelpMan Class Reference

#include <util.h>

Collaboration diagram for RPCHelpMan:
[legend]

Public Member Functions

 RPCHelpMan (std::string name, std::string description, std::vector< RPCArg > args, RPCResults results, RPCExamples examples)
 
std::string ToString () const
 
bool IsValidNumArgs (size_t num_args) const
 If the supplied number of args is neither too small nor too high. More...
 
void Check (const JSONRPCRequest &request) const
 Check if the given request is valid according to this command or if the user is asking for help information, and throw help when appropriate. More...
 

Private Attributes

const std::string m_name
 
const std::string m_description
 
const std::vector< RPCArgm_args
 
const RPCResults m_results
 
const RPCExamples m_examples
 

Detailed Description

Definition at line 238 of file util.h.

Constructor & Destructor Documentation

◆ RPCHelpMan()

RPCHelpMan::RPCHelpMan ( std::string  name,
std::string  description,
std::vector< RPCArg args,
RPCResults  results,
RPCExamples  examples 
)

Definition at line 422 of file util.cpp.

Member Function Documentation

◆ Check()

void RPCHelpMan::Check ( const JSONRPCRequest request) const
inline

Check if the given request is valid according to this command or if the user is asking for help information, and throw help when appropriate.

Definition at line 250 of file util.h.

Here is the call graph for this function:

◆ IsValidNumArgs()

bool RPCHelpMan::IsValidNumArgs ( size_t  num_args) const

If the supplied number of args is neither too small nor too high.

Definition at line 455 of file util.cpp.

◆ ToString()

std::string RPCHelpMan::ToString ( ) const

Definition at line 466 of file util.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_args

const std::vector<RPCArg> RPCHelpMan::m_args
private

Definition at line 259 of file util.h.

◆ m_description

const std::string RPCHelpMan::m_description
private

Definition at line 258 of file util.h.

◆ m_examples

const RPCExamples RPCHelpMan::m_examples
private

Definition at line 261 of file util.h.

◆ m_name

const std::string RPCHelpMan::m_name
private

Definition at line 257 of file util.h.

◆ m_results

const RPCResults RPCHelpMan::m_results
private

Definition at line 260 of file util.h.


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