feat: add nil function

threeal · Dec 26, 2023 · 75283c3 · 75283c3
1 parent 00c5dcd
commit 75283c3
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/include/errors/error.hpp b/include/errors/error.hpp
@@ -54,6 +54,7 @@ class Error {
   explicit operator bool() const;
 
   friend Error make(const std::string& msg);
+  friend const Error& nil();
 
   /**
    * @brief Writes the string representation of an error object to the given
@@ -83,4 +84,11 @@ class Error {
  */
 Error make(const std::string& msg);
 
+
+/**
+ * @brief Gets a constant reference of an empty error.
+ * @return A constant reference of an empty error.
+ */
+const Error& nil();
+
 }  // namespace error
diff --git a/src/error.cpp b/src/error.cpp
@@ -23,4 +23,9 @@ Error make(const std::string& msg) {
   return Error(std::make_shared<const std::string>(msg));
 }
 
+const Error& nil() {
+  static const Error err(nullptr);
+  return err;
+}
+
 }  // namespace error
diff --git a/test/error_test.cpp b/test/error_test.cpp
@@ -9,7 +9,7 @@ TEST_CASE("Error Construction") {
 }
 
 TEST_CASE("Empty Error Construction") {
-  const errors::Error err;
+  const auto err = errors::nil();
   REQUIRE_FALSE(err);
   REQUIRE(err.message() == "no error");
 }