Introducing ReturnValue

andreagilardoni · andreagilardoni · commit a9cc59b6f0cb · 2025-07-17T17:10:59.000+02:00
The objective of ReturnValue is to maintain coherency with ErrorCode
class in cases where a single value is used to represent both the error
and the return value
diff --git a/api/ErrorCodes.h b/api/ErrorCodes.h
@@ -27,5 +27,38 @@ class ErrorCode {
     }
 };
 
+/* ReturnValueClass is meant to represent all the cases where with a single value
+ * we want to return an error, if the value is negative, or a meaningful result
+ * if greater than or equal to 0.
+ * In order to be retrocompatible with the previous definition boolean evaluation:
+ * - It must return true, if the value is greater than or equal 0
+ * - It must return false, if the value is negatie
+ * - It must be evaluable as the primitive type associated with
+ */
+template<typename T>
+class ReturnValueClass {
+public:
+    constexpr ReturnValueClass(T value)
+    : value(value >= 0? value : 0), error(value < 0? value : ArduinoSuccess) {}
+
+    // it would be nice to have a default value on error to Success
+    constexpr ReturnValueClass(T value, error_t error)
+    : value(value), error(error) {}
+
+    const T value;
+    const error_t error;
+
+    constexpr operator bool() const {
+        return error == ArduinoSuccess;
+    }
+
+    constexpr operator T() const {
+        return value;
+    }
+};
+
+using ReturnValue       = ReturnValueClass<int>;
+using ReturnBoolValue   = ReturnValueClass<bool>;
+using ReturnLongValue   = ReturnValueClass<int64_t>;
 
 }
