LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

rpc: Add some doxygen comments to utils

Browse source
This commit is contained in:
MarcoFalke 2019-04-04 10:43:22 -04:00
parent 2c364fde42
commit fa652b229e
No known key found for this signature in database
GPG key ID: CE2B75697E69A548
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/rpc/util.cpp
View file

@ -165,6 +165,10 @@ UniValue JSONRPCTransactionError(TransactionError terr, const std::string& err_s
} }
} }
/**
* A pair of strings that can be aligned (through padding) with other Sections
* later on
*/
struct Section { struct Section {
Section(const std::string& left, const std::string& right) Section(const std::string& left, const std::string& right)
: m_left{left}, m_right{right} {} : m_left{left}, m_right{right} {}
@ -172,6 +176,10 @@ struct Section {
const std::string m_right; const std::string m_right;
}; };
/**
* Keeps track of RPCArgs by transforming them into sections for the purpose
* of serializing everything to a single string
*/
struct Sections { struct Sections {
std::vector<Section> m_sections; std::vector<Section> m_sections;
size_t m_max_pad{0}; size_t m_max_pad{0};
@ -182,12 +190,20 @@ struct Sections {
m_sections.push_back(s); m_sections.push_back(s);
} }
/**
* Serializing RPCArgs depends on the outer type. Only arrays and
* dictionaries can be nested in json. The top-level outer type is "named
* arguments", a mix between a dictionary and arrays.
*/
enum class OuterType { enum class OuterType {
ARR, ARR,
OBJ, OBJ,
NAMED_ARG, // Only set on first recursion NAMED_ARG, // Only set on first recursion
}; };
/**
* Recursive helper to translate an RPCArg into sections
*/
void Push(const RPCArg& arg, const size_t current_indent = 5, const OuterType outer_type = OuterType::NAMED_ARG) void Push(const RPCArg& arg, const size_t current_indent = 5, const OuterType outer_type = OuterType::NAMED_ARG)
{ {
const auto indent = std::string(current_indent, ' '); const auto indent = std::string(current_indent, ' ');
@ -241,6 +257,9 @@ struct Sections {
} }
} }
/**
* Concatenate all sections with proper padding
*/
std::string ToString() const std::string ToString() const
{ {
std::string ret; std::string ret;