1 files changed, 83 insertions, 0 deletions
diff --git a/src/components/utils/include/utils/optional.h b/src/components/utils/include/utils/optional.h
new file mode 100644
index 0000000000..0395945de0
--- /dev/null
+++ b/src/components/utils/include/utils/optional.h
@@ -0,0 +1,83 @@
+#ifndef ERROR_OR_H
+#define ERROR_OR_H
+#include <string>
+#include "utils/macro.h"
+
+namespace utils {
+
+/**
+ * @brief The Optional class is able to keep value, manage it it is empty and
+ * specify error code.
+ * Can be used as return value of function that is not guarantee that vaue will
+ * be returned
+ *
+ */
+template <typename ObjectType, typename ErrorType = std::string>
+class Optional {
+ public:
+  /**
+   * @brief The OptionalEmpty enum enum with one value to specify that Optional
+   * is not initialized
+   */
+  enum OptionalEmpty { EMPTY };
+
+  /**
+   * @brief Optional constructor with object initialization
+   * @param object object to initialize Optional
+   */
+  Optional(ObjectType& object)
+      : object_(&object), error_(), is_initialized_(true) {}
+
+  /**
+   * @brief Optional constructor with object and error initialization
+   * @param object object to initialize Optional
+   * @param error error code initialization
+   */
+  Optional(ObjectType& object, ErrorType error)
+      : object_(&object), error_(error), is_initialized_(true) {}
+
+  /**
+   * @brief Optional constructir without object initialization
+   * @param empty manadatory parameter for explicit specifying that Optional is
+   * empty
+   * @param error error code initialization
+   */
+  Optional(OptionalEmpty empty, ErrorType error)
+      : object_(nullptr), error_(error), is_initialized_(false) {}
+
+  /**
+   * @brief Optional empty optional initialization without specifying error code
+   * @param empty manadatory parameter for explicit specifying that Optional is
+   * empty
+   */
+  Optional(OptionalEmpty empty)
+      : object_(nullptr), error_(), is_initialized_(false) {}
+
+  /**
+   * @brief operator bool operator for checking if optional is initialized
+   */
+  operator bool() const {
+    return is_initialized_;
+  }
+
+  /**
+   * @brief operator * access to object
+   * @return
+   */
+  ObjectType& operator*() const {
+    DCHECK(is_initialized_);
+    return *object_;
+  }
+
+  ErrorType error() const {
+    return error_;
+  }
+
+ private:
+  ObjectType* object_;
+  ErrorType error_;
+  bool is_initialized_;
+};
+
+}  // utils utils
+#endif  // ERROR_OR_H