mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-02-22 15:04:44 +01:00
Introduce generic 'Result' class
Useful to encapsulate the function result object (in case of having it) or, in case of failure, the failure reason. This let us clean lot of boilerplate code, as now instead of returning a boolean and having to add a ref arg for the return object and another ref for the error string. We can simply return a 'BResult<Obj>'. Example of what we currently have: ``` bool doSomething(arg1, arg2, arg3, arg4, &result, &error_string) { do something... if (error) { error_string = "something bad happened"; return false; } result = goodResult; return true; } ``` Example of what we will get with this commit: ``` BResult<Obj> doSomething(arg1, arg2, arg3, arg4) { do something... if (error) return {"something happened"}; // good return {goodResult}; } ``` This allows a similar boilerplate cleanup on the function callers side as well. They don't have to add the extra pre-function-call error string and result object declarations to pass the references to the function.
This commit is contained in:
parent
b9f9ed4640
commit
7a45c33d1f
2 changed files with 44 additions and 0 deletions
|
@ -277,6 +277,7 @@ BITCOIN_CORE_H = \
|
||||||
util/overloaded.h \
|
util/overloaded.h \
|
||||||
util/rbf.h \
|
util/rbf.h \
|
||||||
util/readwritefile.h \
|
util/readwritefile.h \
|
||||||
|
util/result.h \
|
||||||
util/serfloat.h \
|
util/serfloat.h \
|
||||||
util/settings.h \
|
util/settings.h \
|
||||||
util/sock.h \
|
util/sock.h \
|
||||||
|
|
43
src/util/result.h
Normal file
43
src/util/result.h
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
// Copyright (c) 2022 The Bitcoin Core developers
|
||||||
|
// Distributed under the MIT software license, see the accompanying
|
||||||
|
// file COPYING or https://www.opensource.org/licenses/mit-license.php.
|
||||||
|
|
||||||
|
#ifndef BITCOIN_UTIL_RESULT_H
|
||||||
|
#define BITCOIN_UTIL_RESULT_H
|
||||||
|
|
||||||
|
#include <util/translation.h>
|
||||||
|
#include <variant>
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 'BResult' is a generic class useful for wrapping a return object
|
||||||
|
* (in case of success) or propagating the error cause.
|
||||||
|
*/
|
||||||
|
template<class T>
|
||||||
|
class BResult {
|
||||||
|
private:
|
||||||
|
std::variant<bilingual_str, T> m_variant;
|
||||||
|
|
||||||
|
public:
|
||||||
|
BResult() : m_variant(Untranslated("")) {}
|
||||||
|
BResult(const T& _obj) : m_variant(_obj) {}
|
||||||
|
BResult(const bilingual_str& error) : m_variant(error) {}
|
||||||
|
|
||||||
|
/* Whether the function succeeded or not */
|
||||||
|
bool HasRes() const { return std::holds_alternative<T>(m_variant); }
|
||||||
|
|
||||||
|
/* In case of success, the result object */
|
||||||
|
const T& GetObj() const {
|
||||||
|
assert(HasRes());
|
||||||
|
return std::get<T>(m_variant);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* In case of failure, the error cause */
|
||||||
|
const bilingual_str& GetError() const {
|
||||||
|
assert(!HasRes());
|
||||||
|
return std::get<bilingual_str>(m_variant);
|
||||||
|
}
|
||||||
|
|
||||||
|
explicit operator bool() const { return HasRes(); }
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // BITCOIN_UTIL_RESULT_H
|
Loading…
Add table
Reference in a new issue